lnet/lnet/lib-md.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2012, 2017, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lnet/lnet/lib-md.c
  33  *
  34  * Memory Descriptor management routines
  35  */
  36
  37 #define DEBUG_SUBSYSTEM S_LNET
  38
  39 #include <lnet/lib-lnet.h>
  40
  41 /* must be called with lnet_res_lock held */
  42 void
  43 lnet_md_unlink(struct lnet_libmd *md)
  44 {
  45         if ((md->md_flags & LNET_MD_FLAG_ZOMBIE) == 0) {
  46                 /* first unlink attempt... */
  47                 struct lnet_me *me = md->md_me;
  48
  49                 md->md_flags |= LNET_MD_FLAG_ZOMBIE;
  50
  51                 /* Disassociate from ME (if any), and unlink it if it was created
  52                  * with LNET_UNLINK */
  53                 if (me != NULL) {
  54                         /* detach MD from portal */
  55                         lnet_ptl_detach_md(me, md);
  56                         if (me->me_unlink == LNET_UNLINK)
  57                                 lnet_me_unlink(me);
  58                 }
  59
  60                 /* ensure all future handle lookups fail */
  61                 lnet_res_lh_invalidate(&md->md_lh);
  62         }
  63
  64         if (md->md_refcount != 0) {
  65                 CDEBUG(D_NET, "Queueing unlink of md %p\n", md);
  66                 return;
  67         }
  68
  69         CDEBUG(D_NET, "Unlinking md %p\n", md);
  70
  71         LASSERT(!list_empty(&md->md_list));
  72         list_del_init(&md->md_list);
  73         lnet_md_free(md);
  74 }
  75
  76 struct page *
  77 lnet_kvaddr_to_page(unsigned long vaddr)
  78 {
  79         if (is_vmalloc_addr((void *)vaddr))
  80                 return vmalloc_to_page((void *)vaddr);
  81
  82 #ifdef CONFIG_HIGHMEM
  83
  84 #ifdef HAVE_KMAP_TO_PAGE
  85         /*
  86          * This ifdef is added to handle the kernel versions
  87          * which have kmap_to_page() function exported. If so,
  88          * we should use it. Otherwise, remain with the legacy check.
  89          */
  90         return kmap_to_page((void *)vaddr);
  91 #else
  92
  93         if (vaddr >= PKMAP_ADDR(0) && vaddr < PKMAP_ADDR(LAST_PKMAP)) {
  94                 /* No highmem pages only used for bulk (kiov) I/O */
  95                 CERROR("find page for address in highmem\n");
  96                 LBUG();
  97         }
  98         return virt_to_page(vaddr);
  99 #endif /* HAVE_KMAP_TO_PAGE */
 100 #else
 101
 102         return virt_to_page(vaddr);
 103 #endif /* CONFIG_HIGHMEM */
 104 }
 105 EXPORT_SYMBOL(lnet_kvaddr_to_page);
 106
 107 int
 108 lnet_cpt_of_md(struct lnet_libmd *md, unsigned int offset)
 109 {
 110         int cpt = CFS_CPT_ANY;
 111         unsigned int niov;
 112
 113         /*
 114          * if the md_options has a bulk handle then we want to look at the
 115          * bulk md because that's the data which we will be DMAing
 116          */
 117         if (md && (md->md_options & LNET_MD_BULK_HANDLE) != 0 &&
 118             !LNetMDHandleIsInvalid(md->md_bulk_handle))
 119                 md = lnet_handle2md(&md->md_bulk_handle);
 120
 121         if (!md || md->md_niov == 0)
 122                 return CFS_CPT_ANY;
 123
 124         niov = md->md_niov;
 125
 126         /*
 127          * There are three cases to handle:
 128          *  1. The MD is using struct bio_vec
 129          *  2. The MD is using struct kvec
 130          *  3. Contiguous buffer allocated via vmalloc
 131          *
 132          *  in case 2 we can use virt_to_page() macro to get the page
 133          *  address of the memory kvec describes.
 134          *
 135          *  in case 3 use is_vmalloc_addr() and vmalloc_to_page()
 136          *
 137          * The offset provided can be within the first iov/kiov entry or
 138          * it could go beyond it. In that case we need to make sure to
 139          * look at the page which actually contains the data that will be
 140          * DMAed.
 141          */
 142         if ((md->md_options & LNET_MD_KIOV) != 0) {
 143                 struct bio_vec *kiov = md->md_iov.kiov;
 144
 145                 while (offset >= kiov->bv_len) {
 146                         offset -= kiov->bv_len;
 147                         niov--;
 148                         kiov++;
 149                         if (niov == 0) {
 150                                 CERROR("offset %d goes beyond kiov\n", offset);
 151                                 goto out;
 152                         }
 153                 }
 154
 155                 cpt = cfs_cpt_of_node(lnet_cpt_table(),
 156                                 page_to_nid(kiov->bv_page));
 157         } else {
 158                 struct kvec *iov = md->md_iov.iov;
 159                 unsigned long vaddr;
 160                 struct page *page;
 161
 162                 while (offset >= iov->iov_len) {
 163                         offset -= iov->iov_len;
 164                         niov--;
 165                         iov++;
 166                         if (niov == 0) {
 167                                 CERROR("offset %d goes beyond iov\n", offset);
 168                                 goto out;
 169                         }
 170                 }
 171
 172                 vaddr = ((unsigned long)iov->iov_base) + offset;
 173                 page = lnet_kvaddr_to_page(vaddr);
 174                 if (!page) {
 175                         CERROR("Couldn't resolve vaddr 0x%lx to page\n", vaddr);
 176                         goto out;
 177                 }
 178                 cpt = cfs_cpt_of_node(lnet_cpt_table(), page_to_nid(page));
 179         }
 180
 181 out:
 182         return cpt;
 183 }
 184
 185 static int
 186 lnet_md_build(struct lnet_libmd *lmd, struct lnet_md *umd, int unlink)
 187 {
 188         int          i;
 189         unsigned int niov;
 190         int          total_length = 0;
 191
 192         lmd->md_me = NULL;
 193         lmd->md_start = umd->start;
 194         lmd->md_offset = 0;
 195         lmd->md_max_size = umd->max_size;
 196         lmd->md_options = umd->options;
 197         lmd->md_user_ptr = umd->user_ptr;
 198         lmd->md_eq = NULL;
 199         lmd->md_threshold = umd->threshold;
 200         lmd->md_refcount = 0;
 201         lmd->md_flags = (unlink == LNET_UNLINK) ? LNET_MD_FLAG_AUTO_UNLINK : 0;
 202         lmd->md_bulk_handle = umd->bulk_handle;
 203
 204         if ((umd->options & LNET_MD_KIOV) != 0) {
 205                 lmd->md_niov = niov = umd->length;
 206                 memcpy(lmd->md_iov.kiov, umd->start,
 207                        niov * sizeof(lmd->md_iov.kiov[0]));
 208
 209                 for (i = 0; i < (int)niov; i++) {
 210                         /* We take the page pointer on trust */
 211                         if (lmd->md_iov.kiov[i].bv_offset +
 212                             lmd->md_iov.kiov[i].bv_len > PAGE_SIZE)
 213                                 return -EINVAL; /* invalid length */
 214
 215                         total_length += lmd->md_iov.kiov[i].bv_len;
 216                 }
 217
 218                 lmd->md_length = total_length;
 219
 220                 if ((umd->options & LNET_MD_MAX_SIZE) != 0 && /* max size used */
 221                     (umd->max_size < 0 ||
 222                      umd->max_size > total_length)) // illegal max_size
 223                         return -EINVAL;
 224         } else {   /* contiguous */
 225                 lmd->md_length = umd->length;
 226                 lmd->md_niov = niov = 1;
 227                 lmd->md_iov.iov[0].iov_base = umd->start;
 228                 lmd->md_iov.iov[0].iov_len = umd->length;
 229
 230                 if ((umd->options & LNET_MD_MAX_SIZE) != 0 && /* max size used */
 231                     (umd->max_size < 0 ||
 232                      umd->max_size > (int)umd->length)) // illegal max_size
 233                         return -EINVAL;
 234         }
 235
 236         return 0;
 237 }
 238
 239 /* must be called with resource lock held */
 240 static int
 241 lnet_md_link(struct lnet_libmd *md, struct lnet_eq *eq, int cpt)
 242 {
 243         struct lnet_res_container *container = the_lnet.ln_md_containers[cpt];
 244
 245         /* NB we are passed an allocated, but inactive md.
 246          * if we return success, caller may lnet_md_unlink() it.
 247          * otherwise caller may only lnet_md_free() it.
 248          */
 249         /* This implementation doesn't know how to create START events or
 250          * disable END events.  Best to LASSERT our caller is compliant so
 251          * we find out quickly...  */
 252         /*  TODO - reevaluate what should be here in light of
 253          * the removal of the start and end events
 254          * maybe there we shouldn't even allow LNET_EQ_NONE!)
 255          * LASSERT (eq == NULL);
 256          */
 257         if (eq)
 258                 md->md_eq = eq;
 259
 260         lnet_res_lh_initialize(container, &md->md_lh);
 261
 262         LASSERT(list_empty(&md->md_list));
 263         list_add(&md->md_list, &container->rec_active);
 264
 265         return 0;
 266 }
 267
 268 /* must be called with lnet_res_lock held */
 269 void
 270 lnet_md_deconstruct(struct lnet_libmd *lmd, struct lnet_md *umd)
 271 {
 272         /* NB this doesn't copy out all the iov entries so when a
 273          * discontiguous MD is copied out, the target gets to know the
 274          * original iov pointer (in start) and the number of entries it had
 275          * and that's all.
 276          */
 277         umd->start = lmd->md_start;
 278         umd->length = ((lmd->md_options & LNET_MD_KIOV) == 0) ?
 279                       lmd->md_length : lmd->md_niov;
 280         umd->threshold = lmd->md_threshold;
 281         umd->max_size = lmd->md_max_size;
 282         umd->options = lmd->md_options;
 283         umd->user_ptr = lmd->md_user_ptr;
 284 }
 285
 286 static int
 287 lnet_md_validate(struct lnet_md *umd)
 288 {
 289         if (umd->start == NULL && umd->length != 0) {
 290                 CERROR("MD start pointer can not be NULL with length %u\n",
 291                        umd->length);
 292                 return -EINVAL;
 293         }
 294
 295         if ((umd->options & LNET_MD_KIOV) &&
 296             umd->length > LNET_MAX_IOV) {
 297                 CERROR("Invalid option: too many fragments %u, %d max\n",
 298                        umd->length, LNET_MAX_IOV);
 299                 return -EINVAL;
 300         }
 301
 302         return 0;
 303 }
 304
 305 /**
 306  * Create a memory descriptor and attach it to a ME
 307  *
 308  * \param me An ME to associate the new MD with.
 309  * \param umd Provides initial values for the user-visible parts of a MD.
 310  * Other than its use for initialization, there is no linkage between this
 311  * structure and the MD maintained by the LNet.
 312  * \param unlink A flag to indicate whether the MD is automatically unlinked
 313  * when it becomes inactive, either because the operation threshold drops to
 314  * zero or because the available memory becomes less than \a umd.max_size.
 315  * (Note that the check for unlinking a MD only occurs after the completion
 316  * of a successful operation on the MD.) The value LNET_UNLINK enables auto
 317  * unlinking; the value LNET_RETAIN disables it.
 318  * \param handle On successful returns, a handle to the newly created MD is
 319  * saved here. This handle can be used later in LNetMDUnlink().
 320  *
 321  * \retval 0       On success.
 322  * \retval -EINVAL If \a umd is not valid.
 323  * \retval -ENOMEM If new MD cannot be allocated.
 324  * \retval -ENOENT Either \a meh or \a umd.eq_handle does not point to a
 325  * valid object. Note that it's OK to supply a NULL \a umd.eq_handle by
 326  * calling LNetInvalidateHandle() on it.
 327  * \retval -EBUSY  If the ME pointed to by \a meh is already associated with
 328  * a MD.
 329  */
 330 int
 331 LNetMDAttach(struct lnet_me *me, struct lnet_md umd,
 332              enum lnet_unlink unlink, struct lnet_handle_md *handle)
 333 {
 334         LIST_HEAD(matches);
 335         LIST_HEAD(drops);
 336         struct lnet_libmd       *md;
 337         int                     cpt;
 338         int                     rc;
 339
 340         LASSERT(the_lnet.ln_refcount > 0);
 341
 342         if (lnet_md_validate(&umd) != 0)
 343                 return -EINVAL;
 344
 345         if ((umd.options & (LNET_MD_OP_GET | LNET_MD_OP_PUT)) == 0) {
 346                 CERROR("Invalid option: no MD_OP set\n");
 347                 return -EINVAL;
 348         }
 349
 350         md = lnet_md_alloc(&umd);
 351         if (md == NULL)
 352                 return -ENOMEM;
 353
 354         rc = lnet_md_build(md, &umd, unlink);
 355         if (rc != 0)
 356                 goto out_free;
 357
 358         cpt = me->me_cpt;
 359
 360         lnet_res_lock(cpt);
 361
 362         if (me->me_md)
 363                 rc = -EBUSY;
 364         else
 365                 rc = lnet_md_link(md, umd.eq_handle, cpt);
 366
 367         if (rc != 0)
 368                 goto out_unlock;
 369
 370         /* attach this MD to portal of ME and check if it matches any
 371          * blocked msgs on this portal */
 372         lnet_ptl_attach_md(me, md, &matches, &drops);
 373
 374         lnet_md2handle(handle, md);
 375
 376         lnet_res_unlock(cpt);
 377
 378         lnet_drop_delayed_msg_list(&drops, "Bad match");
 379         lnet_recv_delayed_msg_list(&matches);
 380
 381         return 0;
 382
 383 out_unlock:
 384         lnet_res_unlock(cpt);
 385 out_free:
 386         lnet_md_free(md);
 387         return rc;
 388 }
 389 EXPORT_SYMBOL(LNetMDAttach);
 390
 391 /**
 392  * Create a "free floating" memory descriptor - a MD that is not associated
 393  * with a ME. Such MDs are usually used in LNetPut() and LNetGet() operations.
 394  *
 395  * \param umd,unlink See the discussion for LNetMDAttach().
 396  * \param handle On successful returns, a handle to the newly created MD is
 397  * saved here. This handle can be used later in LNetMDUnlink(), LNetPut(),
 398  * and LNetGet() operations.
 399  *
 400  * \retval 0       On success.
 401  * \retval -EINVAL If \a umd is not valid.
 402  * \retval -ENOMEM If new MD cannot be allocated.
 403  * \retval -ENOENT \a umd.eq_handle does not point to a valid EQ. Note that
 404  * it's OK to supply a NULL \a umd.eq_handle by calling
 405  * LNetInvalidateHandle() on it.
 406  */
 407 int
 408 LNetMDBind(struct lnet_md umd, enum lnet_unlink unlink,
 409            struct lnet_handle_md *handle)
 410 {
 411         struct lnet_libmd       *md;
 412         int             cpt;
 413         int             rc;
 414
 415         LASSERT(the_lnet.ln_refcount > 0);
 416
 417         if (lnet_md_validate(&umd) != 0)
 418                 return -EINVAL;
 419
 420         if ((umd.options & (LNET_MD_OP_GET | LNET_MD_OP_PUT)) != 0) {
 421                 CERROR("Invalid option: GET|PUT illegal on active MDs\n");
 422                 return -EINVAL;
 423         }
 424
 425         md = lnet_md_alloc(&umd);
 426         if (md == NULL)
 427                 return -ENOMEM;
 428
 429         rc = lnet_md_build(md, &umd, unlink);
 430         if (rc != 0)
 431                 goto out_free;
 432
 433         if (md->md_length > LNET_MTU) {
 434                 CERROR("Invalid length: too big transfer size %u, %d max\n",
 435                        md->md_length, LNET_MTU);
 436                 rc = -EINVAL;
 437                 goto out_free;
 438         }
 439
 440         cpt = lnet_res_lock_current();
 441
 442         rc = lnet_md_link(md, umd.eq_handle, cpt);
 443         if (rc != 0)
 444                 goto out_unlock;
 445
 446         lnet_md2handle(handle, md);
 447
 448         lnet_res_unlock(cpt);
 449         return 0;
 450
 451  out_unlock:
 452         lnet_res_unlock(cpt);
 453
 454  out_free:
 455         lnet_md_free(md);
 456         return rc;
 457 }
 458 EXPORT_SYMBOL(LNetMDBind);
 459
 460 /**
 461  * Unlink the memory descriptor from any ME it may be linked to and release
 462  * the internal resources associated with it. As a result, active messages
 463  * associated with the MD may get aborted.
 464  *
 465  * This function does not free the memory region associated with the MD;
 466  * i.e., the memory the user allocated for this MD. If the ME associated with
 467  * this MD is not NULL and was created with auto unlink enabled, the ME is
 468  * unlinked as well (see LNetMEAttach()).
 469  *
 470  * Explicitly unlinking a MD via this function call has the same behavior as
 471  * a MD that has been automatically unlinked, except that no LNET_EVENT_UNLINK
 472  * is generated in the latter case.
 473  *
 474  * An unlinked event can be reported in two ways:
 475  * - If there's no pending operations on the MD, it's unlinked immediately
 476  *   and an LNET_EVENT_UNLINK event is logged before this function returns.
 477  * - Otherwise, the MD is only marked for deletion when this function
 478  *   returns, and the unlinked event will be piggybacked on the event of
 479  *   the completion of the last operation by setting the unlinked field of
 480  *   the event. No dedicated LNET_EVENT_UNLINK event is generated.
 481  *
 482  * Note that in both cases the unlinked field of the event is always set; no
 483  * more event will happen on the MD after such an event is logged.
 484  *
 485  * \param mdh A handle for the MD to be unlinked.
 486  *
 487  * \retval 0       On success.
 488  * \retval -ENOENT If \a mdh does not point to a valid MD object.
 489  */
 490 int
 491 LNetMDUnlink(struct lnet_handle_md mdh)
 492 {
 493         struct lnet_event ev;
 494         struct lnet_libmd *md;
 495         int cpt;
 496
 497         LASSERT(the_lnet.ln_refcount > 0);
 498
 499         cpt = lnet_cpt_of_cookie(mdh.cookie);
 500         lnet_res_lock(cpt);
 501
 502         md = lnet_handle2md(&mdh);
 503         if (md == NULL) {
 504                 lnet_res_unlock(cpt);
 505                 return -ENOENT;
 506         }
 507
 508         md->md_flags |= LNET_MD_FLAG_ABORTED;
 509         /* If the MD is busy, lnet_md_unlink just marks it for deletion, and
 510          * when the LND is done, the completion event flags that the MD was
 511          * unlinked. Otherwise, we enqueue an event now... */
 512         if (md->md_eq != NULL && md->md_refcount == 0) {
 513                 lnet_build_unlink_event(md, &ev);
 514                 lnet_eq_enqueue_event(md->md_eq, &ev);
 515         }
 516
 517         if (md->md_rspt_ptr != NULL)
 518                 lnet_detach_rsp_tracker(md, cpt);
 519
 520         lnet_md_unlink(md);
 521
 522         lnet_res_unlock(cpt);
 523         return 0;
 524 }
 525 EXPORT_SYMBOL(LNetMDUnlink);