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  *
  31  * lnet/lnet/lib-md.c
  32  *
  33  * Memory Descriptor management routines
  34  */
  35
  36 #define DEBUG_SUBSYSTEM S_LNET
  37
  38 #include <lnet/lib-lnet.h>
  39
  40 /* must be called with lnet_res_lock held */
  41 void
  42 lnet_md_unlink(struct lnet_libmd *md)
  43 {
  44         if ((md->md_flags & LNET_MD_FLAG_ZOMBIE) == 0) {
  45                 /* first unlink attempt... */
  46                 struct lnet_me *me = md->md_me;
  47
  48                 md->md_flags |= LNET_MD_FLAG_ZOMBIE;
  49
  50                 /* Disassociate from ME (if any), and unlink it if it was created
  51                  * with LNET_UNLINK */
  52                 if (me != NULL) {
  53                         /* detach MD from portal */
  54                         lnet_ptl_detach_md(me, md);
  55                         if (me->me_unlink == LNET_UNLINK)
  56                                 lnet_me_unlink(me);
  57                 }
  58
  59                 /* ensure all future handle lookups fail */
  60                 lnet_res_lh_invalidate(&md->md_lh);
  61         }
  62
  63         if (md->md_refcount != 0) {
  64                 CDEBUG(D_NET, "Queueing unlink of md %p\n", md);
  65                 return;
  66         }
  67
  68         CDEBUG(D_NET, "Unlinking md %p\n", md);
  69
  70         LASSERT(!list_empty(&md->md_list));
  71         list_del_init(&md->md_list);
  72         LASSERT(!(md->md_flags & LNET_MD_FLAG_HANDLING));
  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 struct page *
 108 lnet_get_first_page(struct lnet_libmd *md, unsigned int offset)
 109 {
 110         unsigned int niov;
 111         struct bio_vec *kiov;
 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 NULL;
 123
 124         kiov = md->md_kiov;
 125         niov = md->md_niov;
 126
 127         while (offset >= kiov->bv_len) {
 128                 offset -= kiov->bv_len;
 129                 niov--;
 130                 kiov++;
 131                 if (niov == 0) {
 132                         CERROR("offset %d goes beyond kiov\n", offset);
 133                         return NULL;
 134                 }
 135         }
 136
 137         return kiov->bv_page;
 138 }
 139
 140 int
 141 lnet_cpt_of_md(struct lnet_libmd *md, unsigned int offset)
 142 {
 143         struct page *page;
 144         int cpt = CFS_CPT_ANY;
 145
 146         page = lnet_get_first_page(md, offset);
 147         if (!page) {
 148                 CDEBUG(D_NET, "Couldn't resolve first page of md %p with offset %u\n",
 149                         md, offset);
 150                 goto out;
 151         }
 152
 153         cpt = cfs_cpt_of_node(lnet_cpt_table(), page_to_nid(page));
 154
 155 out:
 156         return cpt;
 157 }
 158
 159 static int lnet_md_validate(const struct lnet_md *umd);
 160
 161 static struct lnet_libmd *
 162 lnet_md_build(const struct lnet_md *umd, int unlink)
 163 {
 164         int i;
 165         unsigned int niov;
 166         int total_length = 0;
 167         struct lnet_libmd *lmd;
 168         unsigned int size;
 169
 170         if (lnet_md_validate(umd) != 0)
 171                 return ERR_PTR(-EINVAL);
 172
 173         if (umd->options & LNET_MD_KIOV)
 174                 niov = umd->length;
 175         else
 176                 niov = DIV_ROUND_UP(offset_in_page(umd->start) + umd->length,
 177                                     PAGE_SIZE);
 178         size = offsetof(struct lnet_libmd, md_kiov[niov]);
 179
 180         if (size <= LNET_SMALL_MD_SIZE) {
 181                 lmd = kmem_cache_zalloc(lnet_small_mds_cachep, GFP_NOFS);
 182                 if (lmd) {
 183                         CDEBUG(D_MALLOC,
 184                                "slab-alloced 'md' of size %u at %p.\n",
 185                                size, lmd);
 186                 } else {
 187                         CDEBUG(D_MALLOC, "failed to allocate 'md' of size %u\n",
 188                                size);
 189                 }
 190         } else {
 191                 LIBCFS_ALLOC(lmd, size);
 192         }
 193
 194         if (!lmd)
 195                 return ERR_PTR(-ENOMEM);
 196
 197         lmd->md_niov = niov;
 198         INIT_LIST_HEAD(&lmd->md_list);
 199         lmd->md_me = NULL;
 200         lmd->md_start = umd->start;
 201         lmd->md_offset = 0;
 202         lmd->md_max_size = umd->max_size;
 203         lmd->md_options = umd->options;
 204         lmd->md_user_ptr = umd->user_ptr;
 205         lmd->md_handler = NULL;
 206         lmd->md_threshold = umd->threshold;
 207         lmd->md_refcount = 0;
 208         lmd->md_flags = (unlink == LNET_UNLINK) ? LNET_MD_FLAG_AUTO_UNLINK : 0;
 209         lmd->md_bulk_handle = umd->bulk_handle;
 210
 211         if (umd->options & LNET_MD_KIOV) {
 212                 memcpy(lmd->md_kiov, umd->start,
 213                        niov * sizeof(lmd->md_kiov[0]));
 214
 215                 for (i = 0; i < (int)niov; i++) {
 216                         /* We take the page pointer on trust */
 217                         if (lmd->md_kiov[i].bv_offset +
 218                             lmd->md_kiov[i].bv_len > PAGE_SIZE) {
 219                                 lnet_md_free(lmd);
 220                                 return ERR_PTR(-EINVAL); /* invalid length */
 221                         }
 222
 223                         total_length += lmd->md_kiov[i].bv_len;
 224                 }
 225
 226                 lmd->md_length = total_length;
 227
 228                 if ((umd->options & LNET_MD_MAX_SIZE) && /* max size used */
 229                     (umd->max_size < 0 ||
 230                      umd->max_size > total_length)) { /* illegal max_size */
 231                         lnet_md_free(lmd);
 232                         return ERR_PTR(-EINVAL);
 233                 }
 234         } else {   /* contiguous - split into pages */
 235                 void *pa = umd->start;
 236                 int len = umd->length;
 237
 238                 lmd->md_length = len;
 239                 i = 0;
 240                 while (len) {
 241                         int plen;
 242
 243                         plen = min_t(int, len, PAGE_SIZE - offset_in_page(pa));
 244
 245                         lmd->md_kiov[i].bv_page =
 246                                 lnet_kvaddr_to_page((unsigned long) pa);
 247                         lmd->md_kiov[i].bv_offset = offset_in_page(pa);
 248                         lmd->md_kiov[i].bv_len = plen;
 249
 250                         len -= plen;
 251                         pa += plen;
 252                         i += 1;
 253                 }
 254                 if ((umd->options & LNET_MD_MAX_SIZE) && /* max size used */
 255                     (umd->max_size < 0 ||
 256                      umd->max_size > (int)umd->length)) { /* illegal max_size */
 257                         lnet_md_free(lmd);
 258                         return ERR_PTR(-EINVAL);
 259                 }
 260                 lmd->md_options |= LNET_MD_KIOV;
 261         }
 262
 263         return lmd;
 264 }
 265
 266 /* must be called with resource lock held */
 267 static void
 268 lnet_md_link(struct lnet_libmd *md, lnet_handler_t handler, int cpt)
 269 {
 270         struct lnet_res_container *container = the_lnet.ln_md_containers[cpt];
 271
 272         /* NB we are passed an allocated, but inactive md.
 273          * Caller may lnet_md_unlink() it, or may lnet_md_free() it.
 274          */
 275         /* This implementation doesn't know how to create START events or
 276          * disable END events.  Best to LASSERT our caller is compliant so
 277          * we find out quickly...  */
 278         /*  TODO - reevaluate what should be here in light of
 279          * the removal of the start and end events
 280          * maybe there we shouldn't even allow LNET_EQ_NONE!)
 281          * LASSERT (handler != NULL);
 282          */
 283         md->md_handler = handler;
 284
 285         lnet_res_lh_initialize(container, &md->md_lh);
 286
 287         LASSERT(list_empty(&md->md_list));
 288         list_add(&md->md_list, &container->rec_active);
 289 }
 290
 291 void lnet_assert_handler_unused(lnet_handler_t handler)
 292 {
 293         struct lnet_res_container *container;
 294         int cpt;
 295
 296         if (!handler)
 297                 return;
 298         cfs_percpt_for_each(container, cpt, the_lnet.ln_md_containers) {
 299                 struct lnet_libmd *md;
 300
 301                 lnet_res_lock(cpt);
 302                 list_for_each_entry(md, &container->rec_active, md_list)
 303                         LASSERT(md->md_handler != handler);
 304                 lnet_res_unlock(cpt);
 305         }
 306 }
 307 EXPORT_SYMBOL(lnet_assert_handler_unused);
 308
 309 /* must be called with lnet_res_lock held */
 310 void
 311 lnet_md_deconstruct(struct lnet_libmd *lmd, struct lnet_event *ev)
 312 {
 313         ev->md_start = lmd->md_start;
 314         ev->md_options = lmd->md_options;
 315         ev->md_user_ptr = lmd->md_user_ptr;
 316 }
 317
 318 static int
 319 lnet_md_validate(const struct lnet_md *umd)
 320 {
 321         if (umd->start == NULL && umd->length != 0) {
 322                 CERROR("MD start pointer can not be NULL with length %u\n",
 323                        umd->length);
 324                 return -EINVAL;
 325         }
 326
 327         if ((umd->options & LNET_MD_KIOV) &&
 328             umd->length > LNET_MAX_IOV) {
 329                 CERROR("Invalid option: too many fragments %u, %d max\n",
 330                        umd->length, LNET_MAX_IOV);
 331                 return -EINVAL;
 332         }
 333
 334         return 0;
 335 }
 336
 337 /**
 338  * Create a memory descriptor and attach it to a ME
 339  *
 340  * \param me An ME to associate the new MD with.
 341  * \param umd Provides initial values for the user-visible parts of a MD.
 342  * Other than its use for initialization, there is no linkage between this
 343  * structure and the MD maintained by the LNet.
 344  * \param unlink A flag to indicate whether the MD is automatically unlinked
 345  * when it becomes inactive, either because the operation threshold drops to
 346  * zero or because the available memory becomes less than \a umd.max_size.
 347  * (Note that the check for unlinking a MD only occurs after the completion
 348  * of a successful operation on the MD.) The value LNET_UNLINK enables auto
 349  * unlinking; the value LNET_RETAIN disables it.
 350  * \param handle On successful returns, a handle to the newly created MD is
 351  * saved here. This handle can be used later in LNetMDUnlink().
 352  *
 353  * The ME will either be linked to the new MD, or it will be freed.
 354  *
 355  * \retval 0       On success.
 356  * \retval -EINVAL If \a umd is not valid.
 357  * \retval -ENOMEM If new MD cannot be allocated.
 358  */
 359 int
 360 LNetMDAttach(struct lnet_me *me, const struct lnet_md *umd,
 361              enum lnet_unlink unlink, struct lnet_handle_md *handle)
 362 {
 363         LIST_HEAD(matches);
 364         LIST_HEAD(drops);
 365         struct lnet_libmd       *md;
 366         int                     cpt;
 367
 368         LASSERT(the_lnet.ln_refcount > 0);
 369         LASSERT(!me->me_md);
 370
 371         if ((umd->options & (LNET_MD_OP_GET | LNET_MD_OP_PUT)) == 0) {
 372                 CERROR("Invalid option: no MD_OP set\n");
 373                 md = ERR_PTR(-EINVAL);
 374         } else
 375                 md = lnet_md_build(umd, unlink);
 376
 377         cpt = me->me_cpt;
 378         lnet_res_lock(cpt);
 379
 380         if (IS_ERR(md)) {
 381                 lnet_me_unlink(me);
 382                 lnet_res_unlock(cpt);
 383                 return PTR_ERR(md);
 384         }
 385
 386         lnet_md_link(md, umd->handler, cpt);
 387
 388         /* attach this MD to portal of ME and check if it matches any
 389          * blocked msgs on this portal */
 390         lnet_ptl_attach_md(me, md, &matches, &drops);
 391
 392         lnet_md2handle(handle, md);
 393
 394         lnet_res_unlock(cpt);
 395
 396         lnet_drop_delayed_msg_list(&drops, "Bad match");
 397         lnet_recv_delayed_msg_list(&matches);
 398
 399         return 0;
 400 }
 401 EXPORT_SYMBOL(LNetMDAttach);
 402
 403 /**
 404  * Create a "free floating" memory descriptor - a MD that is not associated
 405  * with a ME. Such MDs are usually used in LNetPut() and LNetGet() operations.
 406  *
 407  * \param umd,unlink See the discussion for LNetMDAttach().
 408  * \param handle On successful returns, a handle to the newly created MD is
 409  * saved here. This handle can be used later in LNetMDUnlink(), LNetPut(),
 410  * and LNetGet() operations.
 411  *
 412  * \retval 0       On success.
 413  * \retval -EINVAL If \a umd is not valid.
 414  * \retval -ENOMEM If new MD cannot be allocated.
 415  */
 416 int
 417 LNetMDBind(const struct lnet_md *umd, enum lnet_unlink unlink,
 418            struct lnet_handle_md *handle)
 419 {
 420         struct lnet_libmd       *md;
 421         int             cpt;
 422         int             rc;
 423
 424         LASSERT(the_lnet.ln_refcount > 0);
 425
 426         if ((umd->options & (LNET_MD_OP_GET | LNET_MD_OP_PUT)) != 0) {
 427                 CERROR("Invalid option: GET|PUT illegal on active MDs\n");
 428                 return -EINVAL;
 429         }
 430
 431         md = lnet_md_build(umd, unlink);
 432         if (IS_ERR(md))
 433                 return PTR_ERR(md);
 434
 435         if (md->md_length > LNET_MTU) {
 436                 CERROR("Invalid length: too big transfer size %u, %d max\n",
 437                        md->md_length, LNET_MTU);
 438                 rc = -EINVAL;
 439                 goto out_free;
 440         }
 441
 442         cpt = lnet_res_lock_current();
 443
 444         lnet_md_link(md, umd->handler, cpt);
 445
 446         lnet_md2handle(handle, md);
 447
 448         lnet_res_unlock(cpt);
 449         return 0;
 450
 451  out_free:
 452         lnet_md_free(md);
 453         return rc;
 454 }
 455 EXPORT_SYMBOL(LNetMDBind);
 456
 457 /**
 458  * Unlink the memory descriptor from any ME it may be linked to and release
 459  * the internal resources associated with it. As a result, active messages
 460  * associated with the MD may get aborted.
 461  *
 462  * This function does not free the memory region associated with the MD;
 463  * i.e., the memory the user allocated for this MD. If the ME associated with
 464  * this MD is not NULL and was created with auto unlink enabled, the ME is
 465  * unlinked as well (see LNetMEAttach()).
 466  *
 467  * Explicitly unlinking a MD via this function call has the same behavior as
 468  * a MD that has been automatically unlinked, except that no LNET_EVENT_UNLINK
 469  * is generated in the latter case.
 470  *
 471  * An unlinked event can be reported in two ways:
 472  * - If there's no pending operations on the MD, it's unlinked immediately
 473  *   and an LNET_EVENT_UNLINK event is logged before this function returns.
 474  * - Otherwise, the MD is only marked for deletion when this function
 475  *   returns, and the unlinked event will be piggybacked on the event of
 476  *   the completion of the last operation by setting the unlinked field of
 477  *   the event. No dedicated LNET_EVENT_UNLINK event is generated.
 478  *
 479  * Note that in both cases the unlinked field of the event is always set; no
 480  * more event will happen on the MD after such an event is logged.
 481  *
 482  * \param mdh A handle for the MD to be unlinked.
 483  *
 484  * \retval 0       On success.
 485  * \retval -ENOENT If \a mdh does not point to a valid MD object.
 486  */
 487 int
 488 __LNetMDUnlink(struct lnet_handle_md mdh, bool discard)
 489 {
 490         struct lnet_event ev;
 491         struct lnet_libmd *md = NULL;
 492         lnet_handler_t handler = NULL;
 493         int cpt;
 494
 495         LASSERT(the_lnet.ln_refcount > 0);
 496
 497         cpt = lnet_cpt_of_cookie(mdh.cookie);
 498         lnet_res_lock(cpt);
 499         while (!md) {
 500                 md = lnet_handle2md(&mdh);
 501                 if (!md) {
 502                         lnet_res_unlock(cpt);
 503                         return -ENOENT;
 504                 }
 505                 if (md->md_refcount == 0 &&
 506                     md->md_flags & LNET_MD_FLAG_HANDLING) {
 507                         /* Race with unlocked call to ->md_handler. */
 508                         lnet_md_wait_handling(md, cpt);
 509                         md = NULL;
 510                 }
 511         }
 512
 513         md->md_flags |= LNET_MD_FLAG_ABORTED;
 514         /* If the MD is busy, lnet_md_unlink just marks it for deletion, and
 515          * when the LND is done, the completion event flags that the MD was
 516          * unlinked. Otherwise, we enqueue an event now... */
 517         if (md->md_handler && md->md_refcount == 0) {
 518                 lnet_build_unlink_event(md, &ev);
 519                 handler = md->md_handler;
 520         }
 521
 522         if (discard)
 523                 md->md_flags |= LNET_MD_FLAG_DISCARD;
 524
 525         if (md->md_rspt_ptr != NULL)
 526                 lnet_detach_rsp_tracker(md, cpt);
 527
 528         lnet_md_unlink(md);
 529
 530         lnet_res_unlock(cpt);
 531
 532         if (handler)
 533                 handler(&ev);
 534
 535         return 0;
 536 }
 537 EXPORT_SYMBOL(__LNetMDUnlink);
 538
 539 bool
 540 lnet_md_discarded(struct lnet_libmd *md)
 541 {
 542         bool rc;
 543         int cpt;
 544
 545         if (md == NULL)
 546                 return false;
 547
 548         cpt = lnet_cpt_of_cookie(md->md_lh.lh_cookie);
 549         lnet_res_lock(cpt);
 550         rc = md->md_flags & LNET_MD_FLAG_DISCARD;
 551         lnet_res_unlock(cpt);
 552
 553         return rc;
 554 }
 555 EXPORT_SYMBOL(lnet_md_discarded);