lnet/include/lnet/lib-lnet.h

   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/include/lnet/lib-lnet.h
  33  *
  34  * Top level include for library side routines
  35  */
  36
  37 #ifndef __LNET_LIB_LNET_H__
  38 #define __LNET_LIB_LNET_H__
  39
  40 /* LNET has 0xeXXX */
  41 #define CFS_FAIL_PTLRPC_OST_BULK_CB2    0xe000
  42
  43 #include <linux/netdevice.h>
  44
  45 #include <libcfs/libcfs.h>
  46 #include <lnet/api.h>
  47 #include <lnet/lib-types.h>
  48 #include <uapi/linux/lnet/lnet-dlc.h>
  49 #include <uapi/linux/lnet/lnet-types.h>
  50 #include <uapi/linux/lnet/lnetctl.h>
  51 #include <uapi/linux/lnet/nidstr.h>
  52
  53 extern struct lnet the_lnet;                    /* THE network */
  54
  55 #if (BITS_PER_LONG == 32)
  56 /* 2 CPTs, allowing more CPTs might make us under memory pressure */
  57 # define LNET_CPT_MAX_BITS     1
  58
  59 #else /* 64-bit system */
  60 /*
  61  * 256 CPTs for thousands of CPUs, allowing more CPTs might make us
  62  * under risk of consuming all lh_cookie.
  63  */
  64 # define LNET_CPT_MAX_BITS     8
  65 #endif /* BITS_PER_LONG == 32 */
  66
  67 /* max allowed CPT number */
  68 #define LNET_CPT_MAX            (1 << LNET_CPT_MAX_BITS)
  69
  70 #define LNET_CPT_NUMBER         (the_lnet.ln_cpt_number)
  71 #define LNET_CPT_BITS           (the_lnet.ln_cpt_bits)
  72 #define LNET_CPT_MASK           ((1ULL << LNET_CPT_BITS) - 1)
  73
  74 /** exclusive lock */
  75 #define LNET_LOCK_EX            CFS_PERCPT_LOCK_EX
  76
  77 /* default timeout */
  78 #define DEFAULT_PEER_TIMEOUT    180
  79 #define LNET_LND_DEFAULT_TIMEOUT 5
  80
  81 #ifdef HAVE_KERN_SOCK_GETNAME_2ARGS
  82 #define lnet_kernel_getpeername(sock, addr, addrlen) \
  83                 kernel_getpeername(sock, addr)
  84 #define lnet_kernel_getsockname(sock, addr, addrlen) \
  85                 kernel_getsockname(sock, addr)
  86 #else
  87 #define lnet_kernel_getpeername(sock, addr, addrlen) \
  88                 kernel_getpeername(sock, addr, addrlen)
  89 #define lnet_kernel_getsockname(sock, addr, addrlen) \
  90                 kernel_getsockname(sock, addr, addrlen)
  91 #endif
  92
  93 bool lnet_is_route_alive(struct lnet_route *route);
  94 bool lnet_is_gateway_alive(struct lnet_peer *gw);
  95
  96 static inline int lnet_is_wire_handle_none(struct lnet_handle_wire *wh)
  97 {
  98         return (wh->wh_interface_cookie == LNET_WIRE_HANDLE_COOKIE_NONE &&
  99                 wh->wh_object_cookie == LNET_WIRE_HANDLE_COOKIE_NONE);
 100 }
 101
 102 static inline int lnet_md_exhausted(struct lnet_libmd *md)
 103 {
 104         return (md->md_threshold == 0 ||
 105                 ((md->md_options & LNET_MD_MAX_SIZE) != 0 &&
 106                  md->md_offset + md->md_max_size > md->md_length));
 107 }
 108
 109 static inline int lnet_md_unlinkable(struct lnet_libmd *md)
 110 {
 111         /* Should unlink md when its refcount is 0 and either:
 112          *  - md has been flagged for deletion (by auto unlink or LNetM[DE]Unlink,
 113          *    in the latter case md may not be exhausted).
 114          *  - auto unlink is on and md is exhausted.
 115          */
 116         if (md->md_refcount != 0)
 117                 return 0;
 118
 119         if ((md->md_flags & LNET_MD_FLAG_ZOMBIE) != 0)
 120                 return 1;
 121
 122         return ((md->md_flags & LNET_MD_FLAG_AUTO_UNLINK) != 0 &&
 123                 lnet_md_exhausted(md));
 124 }
 125
 126 #define lnet_cpt_table()        (the_lnet.ln_cpt_table)
 127 #define lnet_cpt_current()      cfs_cpt_current(the_lnet.ln_cpt_table, 1)
 128
 129 static inline int
 130 lnet_cpt_of_cookie(__u64 cookie)
 131 {
 132         unsigned int cpt = (cookie >> LNET_COOKIE_TYPE_BITS) & LNET_CPT_MASK;
 133
 134         /* LNET_CPT_NUMBER doesn't have to be power2, which means we can
 135          * get illegal cpt from it's invalid cookie */
 136         return cpt < LNET_CPT_NUMBER ? cpt : cpt % LNET_CPT_NUMBER;
 137 }
 138
 139 static inline void
 140 lnet_res_lock(int cpt)
 141 {
 142         cfs_percpt_lock(the_lnet.ln_res_lock, cpt);
 143 }
 144
 145 static inline void
 146 lnet_res_unlock(int cpt)
 147 {
 148         cfs_percpt_unlock(the_lnet.ln_res_lock, cpt);
 149 }
 150
 151 static inline int
 152 lnet_res_lock_current(void)
 153 {
 154         int cpt = lnet_cpt_current();
 155
 156         lnet_res_lock(cpt);
 157         return cpt;
 158 }
 159
 160 static inline void
 161 lnet_net_lock(int cpt)
 162 {
 163         cfs_percpt_lock(the_lnet.ln_net_lock, cpt);
 164 }
 165
 166 static inline void
 167 lnet_net_unlock(int cpt)
 168 {
 169         cfs_percpt_unlock(the_lnet.ln_net_lock, cpt);
 170 }
 171
 172 static inline int
 173 lnet_net_lock_current(void)
 174 {
 175         int cpt = lnet_cpt_current();
 176
 177         lnet_net_lock(cpt);
 178         return cpt;
 179 }
 180
 181 #define LNET_LOCK()             lnet_net_lock(LNET_LOCK_EX)
 182 #define LNET_UNLOCK()           lnet_net_unlock(LNET_LOCK_EX)
 183
 184 #define lnet_ptl_lock(ptl)      spin_lock(&(ptl)->ptl_lock)
 185 #define lnet_ptl_unlock(ptl)    spin_unlock(&(ptl)->ptl_lock)
 186 #define lnet_eq_wait_lock()     spin_lock(&the_lnet.ln_eq_wait_lock)
 187 #define lnet_eq_wait_unlock()   spin_unlock(&the_lnet.ln_eq_wait_lock)
 188 #define lnet_ni_lock(ni)        spin_lock(&(ni)->ni_lock)
 189 #define lnet_ni_unlock(ni)      spin_unlock(&(ni)->ni_lock)
 190
 191 #define MAX_PORTALS     64
 192
 193 #define LNET_SMALL_MD_SIZE   offsetof(struct lnet_libmd, md_iov.iov[1])
 194 extern struct kmem_cache *lnet_mes_cachep;       /* MEs kmem_cache */
 195 extern struct kmem_cache *lnet_small_mds_cachep; /* <= LNET_SMALL_MD_SIZE bytes
 196                                                   * MDs kmem_cache */
 197
 198 static inline struct lnet_eq *
 199 lnet_eq_alloc (void)
 200 {
 201         struct lnet_eq *eq;
 202
 203         LIBCFS_ALLOC(eq, sizeof(*eq));
 204         return (eq);
 205 }
 206
 207 static inline void
 208 lnet_eq_free(struct lnet_eq *eq)
 209 {
 210         LIBCFS_FREE(eq, sizeof(*eq));
 211 }
 212
 213 static inline struct lnet_libmd *
 214 lnet_md_alloc(struct lnet_md *umd)
 215 {
 216         struct lnet_libmd *md;
 217         unsigned int  size;
 218         unsigned int  niov;
 219
 220         if ((umd->options & LNET_MD_KIOV) != 0) {
 221                 niov = umd->length;
 222                 size = offsetof(struct lnet_libmd, md_iov.kiov[niov]);
 223         } else {
 224                 niov = ((umd->options & LNET_MD_IOVEC) != 0) ?
 225                        umd->length : 1;
 226                 size = offsetof(struct lnet_libmd, md_iov.iov[niov]);
 227         }
 228
 229         if (size <= LNET_SMALL_MD_SIZE) {
 230                 md = kmem_cache_alloc(lnet_small_mds_cachep,
 231                                       GFP_NOFS | __GFP_ZERO);
 232                 if (md) {
 233                         CDEBUG(D_MALLOC, "slab-alloced 'md' of size %u at "
 234                                "%p.\n", size, md);
 235                 } else {
 236                         CDEBUG(D_MALLOC, "failed to allocate 'md' of size %u\n",
 237                                size);
 238                         return NULL;
 239                 }
 240         } else {
 241                 LIBCFS_ALLOC(md, size);
 242         }
 243
 244         if (md != NULL) {
 245                 /* Set here in case of early free */
 246                 md->md_options = umd->options;
 247                 md->md_niov = niov;
 248                 INIT_LIST_HEAD(&md->md_list);
 249         }
 250
 251         return md;
 252 }
 253
 254 static inline void
 255 lnet_md_free(struct lnet_libmd *md)
 256 {
 257         unsigned int  size;
 258
 259         if ((md->md_options & LNET_MD_KIOV) != 0)
 260                 size = offsetof(struct lnet_libmd, md_iov.kiov[md->md_niov]);
 261         else
 262                 size = offsetof(struct lnet_libmd, md_iov.iov[md->md_niov]);
 263
 264         if (size <= LNET_SMALL_MD_SIZE) {
 265                 CDEBUG(D_MALLOC, "slab-freed 'md' at %p.\n", md);
 266                 kmem_cache_free(lnet_small_mds_cachep, md);
 267         } else {
 268                 LIBCFS_FREE(md, size);
 269         }
 270 }
 271
 272 static inline struct lnet_me *
 273 lnet_me_alloc (void)
 274 {
 275         struct lnet_me *me;
 276
 277         me = kmem_cache_alloc(lnet_mes_cachep, GFP_NOFS | __GFP_ZERO);
 278
 279         if (me)
 280                 CDEBUG(D_MALLOC, "slab-alloced 'me' at %p.\n", me);
 281         else
 282                 CDEBUG(D_MALLOC, "failed to allocate 'me'\n");
 283
 284         return me;
 285 }
 286
 287 static inline void
 288 lnet_me_free(struct lnet_me *me)
 289 {
 290         CDEBUG(D_MALLOC, "slab-freed 'me' at %p.\n", me);
 291         kmem_cache_free(lnet_mes_cachep, me);
 292 }
 293
 294 struct lnet_libhandle *lnet_res_lh_lookup(struct lnet_res_container *rec,
 295                                      __u64 cookie);
 296 void lnet_res_lh_initialize(struct lnet_res_container *rec,
 297                             struct lnet_libhandle *lh);
 298 static inline void
 299 lnet_res_lh_invalidate(struct lnet_libhandle *lh)
 300 {
 301         /* ALWAYS called with resource lock held */
 302         /* NB: cookie is still useful, don't reset it */
 303         list_del(&lh->lh_hash_chain);
 304 }
 305
 306 static inline void
 307 lnet_eq2handle(struct lnet_handle_eq *handle, struct lnet_eq *eq)
 308 {
 309         if (eq == NULL) {
 310                 LNetInvalidateEQHandle(handle);
 311                 return;
 312         }
 313
 314         handle->cookie = eq->eq_lh.lh_cookie;
 315 }
 316
 317 static inline struct lnet_eq *
 318 lnet_handle2eq(struct lnet_handle_eq *handle)
 319 {
 320         /* ALWAYS called with resource lock held */
 321         struct lnet_libhandle *lh;
 322
 323         lh = lnet_res_lh_lookup(&the_lnet.ln_eq_container, handle->cookie);
 324         if (lh == NULL)
 325                 return NULL;
 326
 327         return lh_entry(lh, struct lnet_eq, eq_lh);
 328 }
 329
 330 static inline void
 331 lnet_md2handle(struct lnet_handle_md *handle, struct lnet_libmd *md)
 332 {
 333         handle->cookie = md->md_lh.lh_cookie;
 334 }
 335
 336 static inline struct lnet_libmd *
 337 lnet_handle2md(struct lnet_handle_md *handle)
 338 {
 339         /* ALWAYS called with resource lock held */
 340         struct lnet_libhandle *lh;
 341         int              cpt;
 342
 343         cpt = lnet_cpt_of_cookie(handle->cookie);
 344         lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
 345                                 handle->cookie);
 346         if (lh == NULL)
 347                 return NULL;
 348
 349         return lh_entry(lh, struct lnet_libmd, md_lh);
 350 }
 351
 352 static inline struct lnet_libmd *
 353 lnet_wire_handle2md(struct lnet_handle_wire *wh)
 354 {
 355         /* ALWAYS called with resource lock held */
 356         struct lnet_libhandle *lh;
 357         int              cpt;
 358
 359         if (wh->wh_interface_cookie != the_lnet.ln_interface_cookie)
 360                 return NULL;
 361
 362         cpt = lnet_cpt_of_cookie(wh->wh_object_cookie);
 363         lh = lnet_res_lh_lookup(the_lnet.ln_md_containers[cpt],
 364                                 wh->wh_object_cookie);
 365         if (lh == NULL)
 366                 return NULL;
 367
 368         return lh_entry(lh, struct lnet_libmd, md_lh);
 369 }
 370
 371 static inline void
 372 lnet_me2handle(struct lnet_handle_me *handle, struct lnet_me *me)
 373 {
 374         handle->cookie = me->me_lh.lh_cookie;
 375 }
 376
 377 static inline struct lnet_me *
 378 lnet_handle2me(struct lnet_handle_me *handle)
 379 {
 380         /* ALWAYS called with resource lock held */
 381         struct lnet_libhandle *lh;
 382         int              cpt;
 383
 384         cpt = lnet_cpt_of_cookie(handle->cookie);
 385         lh = lnet_res_lh_lookup(the_lnet.ln_me_containers[cpt],
 386                                 handle->cookie);
 387         if (lh == NULL)
 388                 return NULL;
 389
 390         return lh_entry(lh, struct lnet_me, me_lh);
 391 }
 392
 393 static inline void
 394 lnet_peer_net_addref_locked(struct lnet_peer_net *lpn)
 395 {
 396         atomic_inc(&lpn->lpn_refcount);
 397 }
 398
 399 extern void lnet_destroy_peer_net_locked(struct lnet_peer_net *lpn);
 400
 401 static inline void
 402 lnet_peer_net_decref_locked(struct lnet_peer_net *lpn)
 403 {
 404         if (atomic_dec_and_test(&lpn->lpn_refcount))
 405                 lnet_destroy_peer_net_locked(lpn);
 406 }
 407
 408 static inline void
 409 lnet_peer_addref_locked(struct lnet_peer *lp)
 410 {
 411         atomic_inc(&lp->lp_refcount);
 412 }
 413
 414 extern void lnet_destroy_peer_locked(struct lnet_peer *lp);
 415
 416 static inline void
 417 lnet_peer_decref_locked(struct lnet_peer *lp)
 418 {
 419         if (atomic_dec_and_test(&lp->lp_refcount))
 420                 lnet_destroy_peer_locked(lp);
 421 }
 422
 423 static inline void
 424 lnet_peer_ni_addref_locked(struct lnet_peer_ni *lp)
 425 {
 426         LASSERT(atomic_read(&lp->lpni_refcount) > 0);
 427         atomic_inc(&lp->lpni_refcount);
 428 }
 429
 430 extern void lnet_destroy_peer_ni_locked(struct lnet_peer_ni *lp);
 431
 432 static inline void
 433 lnet_peer_ni_decref_locked(struct lnet_peer_ni *lp)
 434 {
 435         LASSERT(atomic_read(&lp->lpni_refcount) > 0);
 436         if (atomic_dec_and_test(&lp->lpni_refcount))
 437                 lnet_destroy_peer_ni_locked(lp);
 438 }
 439
 440 static inline int
 441 lnet_isrouter(struct lnet_peer_ni *lpni)
 442 {
 443         return lpni->lpni_peer_net->lpn_peer->lp_rtr_refcount != 0;
 444 }
 445
 446 static inline void
 447 lnet_ni_addref_locked(struct lnet_ni *ni, int cpt)
 448 {
 449         LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
 450         LASSERT(*ni->ni_refs[cpt] >= 0);
 451
 452         (*ni->ni_refs[cpt])++;
 453 }
 454
 455 static inline void
 456 lnet_ni_addref(struct lnet_ni *ni)
 457 {
 458         lnet_net_lock(0);
 459         lnet_ni_addref_locked(ni, 0);
 460         lnet_net_unlock(0);
 461 }
 462
 463 static inline void
 464 lnet_ni_decref_locked(struct lnet_ni *ni, int cpt)
 465 {
 466         LASSERT(cpt >= 0 && cpt < LNET_CPT_NUMBER);
 467         LASSERT(*ni->ni_refs[cpt] > 0);
 468
 469         (*ni->ni_refs[cpt])--;
 470 }
 471
 472 static inline void
 473 lnet_ni_decref(struct lnet_ni *ni)
 474 {
 475         lnet_net_lock(0);
 476         lnet_ni_decref_locked(ni, 0);
 477         lnet_net_unlock(0);
 478 }
 479
 480 static inline struct lnet_msg *
 481 lnet_msg_alloc(void)
 482 {
 483         struct lnet_msg *msg;
 484
 485         LIBCFS_ALLOC(msg, sizeof(*msg));
 486
 487         /* no need to zero, LIBCFS_ALLOC does for us */
 488         return (msg);
 489 }
 490
 491 static inline void
 492 lnet_msg_free(struct lnet_msg *msg)
 493 {
 494         LASSERT(!msg->msg_onactivelist);
 495         LIBCFS_FREE(msg, sizeof(*msg));
 496 }
 497
 498 static inline struct lnet_rsp_tracker *
 499 lnet_rspt_alloc(int cpt)
 500 {
 501         struct lnet_rsp_tracker *rspt;
 502         LIBCFS_ALLOC(rspt, sizeof(*rspt));
 503         lnet_net_lock(cpt);
 504         the_lnet.ln_counters[cpt]->lct_health.lch_rst_alloc++;
 505         lnet_net_unlock(cpt);
 506         return rspt;
 507 }
 508
 509 static inline void
 510 lnet_rspt_free(struct lnet_rsp_tracker *rspt, int cpt)
 511 {
 512         LIBCFS_FREE(rspt, sizeof(*rspt));
 513         lnet_net_lock(cpt);
 514         the_lnet.ln_counters[cpt]->lct_health.lch_rst_alloc--;
 515         lnet_net_unlock(cpt);
 516 }
 517
 518 void lnet_ni_free(struct lnet_ni *ni);
 519 void lnet_net_free(struct lnet_net *net);
 520
 521 struct lnet_net *
 522 lnet_net_alloc(__u32 net_type, struct list_head *netlist);
 523
 524 struct lnet_ni *
 525 lnet_ni_alloc(struct lnet_net *net, struct cfs_expr_list *el,
 526               char *iface);
 527 struct lnet_ni *
 528 lnet_ni_alloc_w_cpt_array(struct lnet_net *net, __u32 *cpts, __u32 ncpts,
 529                           char *iface);
 530
 531 static inline int
 532 lnet_nid2peerhash(lnet_nid_t nid)
 533 {
 534         return hash_long(nid, LNET_PEER_HASH_BITS);
 535 }
 536
 537 static inline struct list_head *
 538 lnet_net2rnethash(__u32 net)
 539 {
 540         return &the_lnet.ln_remote_nets_hash[(LNET_NETNUM(net) +
 541                 LNET_NETTYP(net)) &
 542                 ((1U << the_lnet.ln_remote_nets_hbits) - 1)];
 543 }
 544
 545 extern struct lnet_lnd the_lolnd;
 546 extern int avoid_asym_router_failure;
 547
 548 extern unsigned int lnet_nid_cpt_hash(lnet_nid_t nid, unsigned int number);
 549 extern int lnet_cpt_of_nid_locked(lnet_nid_t nid, struct lnet_ni *ni);
 550 extern int lnet_cpt_of_nid(lnet_nid_t nid, struct lnet_ni *ni);
 551 extern struct lnet_ni *lnet_nid2ni_locked(lnet_nid_t nid, int cpt);
 552 extern struct lnet_ni *lnet_nid2ni_addref(lnet_nid_t nid);
 553 extern struct lnet_ni *lnet_net2ni_locked(__u32 net, int cpt);
 554 extern struct lnet_ni *lnet_net2ni_addref(__u32 net);
 555 struct lnet_net *lnet_get_net_locked(__u32 net_id);
 556
 557 int lnet_lib_init(void);
 558 void lnet_lib_exit(void);
 559
 560 extern unsigned lnet_transaction_timeout;
 561 extern unsigned lnet_retry_count;
 562 extern unsigned int lnet_numa_range;
 563 extern unsigned int lnet_health_sensitivity;
 564 extern unsigned int lnet_recovery_interval;
 565 extern unsigned int lnet_peer_discovery_disabled;
 566 extern unsigned int lnet_drop_asym_route;
 567 extern unsigned int router_sensitivity_percentage;
 568 extern int alive_router_check_interval;
 569 extern int live_router_check_interval;
 570 extern int dead_router_check_interval;
 571 extern int portal_rotor;
 572
 573 void lnet_mt_event_handler(struct lnet_event *event);
 574
 575 int lnet_notify(struct lnet_ni *ni, lnet_nid_t peer, bool alive, bool reset,
 576                 time64_t when);
 577 void lnet_notify_locked(struct lnet_peer_ni *lp, int notifylnd, int alive,
 578                         time64_t when);
 579 int lnet_add_route(__u32 net, __u32 hops, lnet_nid_t gateway_nid,
 580                    __u32 priority, __u32 sensitivity);
 581 int lnet_del_route(__u32 net, lnet_nid_t gw_nid);
 582 void lnet_destroy_routes(void);
 583 int lnet_get_route(int idx, __u32 *net, __u32 *hops,
 584                    lnet_nid_t *gateway, __u32 *alive, __u32 *priority,
 585                    __u32 *sensitivity);
 586 int lnet_get_rtr_pool_cfg(int idx, struct lnet_ioctl_pool_cfg *pool_cfg);
 587 struct lnet_ni *lnet_get_next_ni_locked(struct lnet_net *mynet,
 588                                         struct lnet_ni *prev);
 589 struct lnet_ni *lnet_get_ni_idx_locked(int idx);
 590
 591 extern int libcfs_ioctl_getdata(struct libcfs_ioctl_hdr **hdr_pp,
 592                                 struct libcfs_ioctl_hdr __user *uparam);
 593 extern int lnet_get_peer_list(__u32 *countp, __u32 *sizep,
 594                               struct lnet_process_id __user *ids);
 595 extern void lnet_peer_ni_set_healthv(lnet_nid_t nid, int value, bool all);
 596 extern void lnet_peer_ni_add_to_recoveryq_locked(struct lnet_peer_ni *lpni);
 597
 598 void lnet_router_debugfs_init(void);
 599 void lnet_router_debugfs_fini(void);
 600 int  lnet_rtrpools_alloc(int im_a_router);
 601 void lnet_destroy_rtrbuf(struct lnet_rtrbuf *rb, int npages);
 602 int  lnet_rtrpools_adjust(int tiny, int small, int large);
 603 int lnet_rtrpools_enable(void);
 604 void lnet_rtrpools_disable(void);
 605 void lnet_rtrpools_free(int keep_pools);
 606 void lnet_rtr_transfer_to_peer(struct lnet_peer *src,
 607                                struct lnet_peer *target);
 608 struct lnet_remotenet *lnet_find_rnet_locked(__u32 net);
 609 int lnet_dyn_add_net(struct lnet_ioctl_config_data *conf);
 610 int lnet_dyn_del_net(__u32 net);
 611 int lnet_dyn_add_ni(struct lnet_ioctl_config_ni *conf);
 612 int lnet_dyn_del_ni(struct lnet_ioctl_config_ni *conf);
 613 int lnet_clear_lazy_portal(struct lnet_ni *ni, int portal, char *reason);
 614 struct lnet_net *lnet_get_net_locked(__u32 net_id);
 615
 616 int lnet_islocalnid(lnet_nid_t nid);
 617 int lnet_islocalnet(__u32 net);
 618 int lnet_islocalnet_locked(__u32 net);
 619
 620 void lnet_msg_attach_md(struct lnet_msg *msg, struct lnet_libmd *md,
 621                         unsigned int offset, unsigned int mlen);
 622 void lnet_build_unlink_event(struct lnet_libmd *md, struct lnet_event *ev);
 623 void lnet_build_msg_event(struct lnet_msg *msg, enum lnet_event_kind ev_type);
 624 void lnet_msg_commit(struct lnet_msg *msg, int cpt);
 625 void lnet_msg_decommit(struct lnet_msg *msg, int cpt, int status);
 626
 627 void lnet_eq_enqueue_event(struct lnet_eq *eq, struct lnet_event *ev);
 628 void lnet_prep_send(struct lnet_msg *msg, int type,
 629                     struct lnet_process_id target, unsigned int offset,
 630                     unsigned int len);
 631 int lnet_send(lnet_nid_t nid, struct lnet_msg *msg, lnet_nid_t rtr_nid);
 632 int lnet_send_ping(lnet_nid_t dest_nid, struct lnet_handle_md *mdh, int nnis,
 633                    void *user_ptr, struct lnet_handle_eq eqh, bool recovery);
 634 void lnet_return_tx_credits_locked(struct lnet_msg *msg);
 635 void lnet_return_rx_credits_locked(struct lnet_msg *msg);
 636 void lnet_schedule_blocked_locked(struct lnet_rtrbufpool *rbp);
 637 void lnet_drop_routed_msgs_locked(struct list_head *list, int cpt);
 638
 639 struct list_head **lnet_create_array_of_queues(void);
 640
 641 /* portals functions */
 642 /* portals attributes */
 643 static inline int
 644 lnet_ptl_is_lazy(struct lnet_portal *ptl)
 645 {
 646         return !!(ptl->ptl_options & LNET_PTL_LAZY);
 647 }
 648
 649 static inline int
 650 lnet_ptl_is_unique(struct lnet_portal *ptl)
 651 {
 652         return !!(ptl->ptl_options & LNET_PTL_MATCH_UNIQUE);
 653 }
 654
 655 static inline int
 656 lnet_ptl_is_wildcard(struct lnet_portal *ptl)
 657 {
 658         return !!(ptl->ptl_options & LNET_PTL_MATCH_WILDCARD);
 659 }
 660
 661 static inline void
 662 lnet_ptl_setopt(struct lnet_portal *ptl, int opt)
 663 {
 664         ptl->ptl_options |= opt;
 665 }
 666
 667 static inline void
 668 lnet_ptl_unsetopt(struct lnet_portal *ptl, int opt)
 669 {
 670         ptl->ptl_options &= ~opt;
 671 }
 672
 673 /* match-table functions */
 674 struct list_head *lnet_mt_match_head(struct lnet_match_table *mtable,
 675                                struct lnet_process_id id, __u64 mbits);
 676 struct lnet_match_table *lnet_mt_of_attach(unsigned int index,
 677                                            struct lnet_process_id id,
 678                                            __u64 mbits, __u64 ignore_bits,
 679                                            enum lnet_ins_pos pos);
 680 int lnet_mt_match_md(struct lnet_match_table *mtable,
 681                      struct lnet_match_info *info, struct lnet_msg *msg);
 682
 683 /* portals match/attach functions */
 684 void lnet_ptl_attach_md(struct lnet_me *me, struct lnet_libmd *md,
 685                         struct list_head *matches, struct list_head *drops);
 686 void lnet_ptl_detach_md(struct lnet_me *me, struct lnet_libmd *md);
 687 int lnet_ptl_match_md(struct lnet_match_info *info, struct lnet_msg *msg);
 688
 689 /* initialized and finalize portals */
 690 int lnet_portals_create(void);
 691 void lnet_portals_destroy(void);
 692
 693 /* message functions */
 694 int lnet_parse(struct lnet_ni *ni, struct lnet_hdr *hdr,
 695                lnet_nid_t fromnid, void *private, int rdma_req);
 696 int lnet_parse_local(struct lnet_ni *ni, struct lnet_msg *msg);
 697 int lnet_parse_forward_locked(struct lnet_ni *ni, struct lnet_msg *msg);
 698
 699 void lnet_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
 700                int delayed, unsigned int offset, unsigned int mlen,
 701                unsigned int rlen);
 702 void lnet_ni_recv(struct lnet_ni *ni, void *private, struct lnet_msg *msg,
 703                   int delayed, unsigned int offset,
 704                   unsigned int mlen, unsigned int rlen);
 705
 706 struct lnet_msg *lnet_create_reply_msg(struct lnet_ni *ni,
 707                                        struct lnet_msg *get_msg);
 708 void lnet_set_reply_msg_len(struct lnet_ni *ni, struct lnet_msg *msg,
 709                             unsigned int len);
 710 void lnet_detach_rsp_tracker(struct lnet_libmd *md, int cpt);
 711 void lnet_clean_zombie_rstqs(void);
 712
 713 void lnet_finalize(struct lnet_msg *msg, int rc);
 714 bool lnet_send_error_simulation(struct lnet_msg *msg,
 715                                 enum lnet_msg_hstatus *hstatus);
 716 void lnet_handle_remote_failure_locked(struct lnet_peer_ni *lpni);
 717
 718 void lnet_drop_message(struct lnet_ni *ni, int cpt, void *private,
 719                        unsigned int nob, __u32 msg_type);
 720 void lnet_drop_delayed_msg_list(struct list_head *head, char *reason);
 721 void lnet_recv_delayed_msg_list(struct list_head *head);
 722
 723 int lnet_msg_container_setup(struct lnet_msg_container *container, int cpt);
 724 void lnet_msg_container_cleanup(struct lnet_msg_container *container);
 725 void lnet_msg_containers_destroy(void);
 726 int lnet_msg_containers_create(void);
 727
 728 char *lnet_health_error2str(enum lnet_msg_hstatus hstatus);
 729 char *lnet_msgtyp2str(int type);
 730 void lnet_print_hdr(struct lnet_hdr *hdr);
 731 int lnet_fail_nid(lnet_nid_t nid, unsigned int threshold);
 732
 733 /** \addtogroup lnet_fault_simulation @{ */
 734
 735 int lnet_fault_ctl(int cmd, struct libcfs_ioctl_data *data);
 736 int lnet_fault_init(void);
 737 void lnet_fault_fini(void);
 738
 739 bool lnet_drop_rule_match(struct lnet_hdr *hdr, lnet_nid_t local_nid,
 740                           enum lnet_msg_hstatus *hstatus);
 741
 742 int lnet_delay_rule_add(struct lnet_fault_attr *attr);
 743 int lnet_delay_rule_del(lnet_nid_t src, lnet_nid_t dst, bool shutdown);
 744 int lnet_delay_rule_list(int pos, struct lnet_fault_attr *attr,
 745                          struct lnet_fault_stat *stat);
 746 void lnet_delay_rule_reset(void);
 747 void lnet_delay_rule_check(void);
 748 bool lnet_delay_rule_match_locked(struct lnet_hdr *hdr, struct lnet_msg *msg);
 749
 750 /** @} lnet_fault_simulation */
 751
 752 void lnet_counters_get_common(struct lnet_counters_common *common);
 753 void lnet_counters_get(struct lnet_counters *counters);
 754 void lnet_counters_reset(void);
 755
 756 unsigned int lnet_iov_nob(unsigned int niov, struct kvec *iov);
 757 int lnet_extract_iov(int dst_niov, struct kvec *dst,
 758                       int src_niov, struct kvec *src,
 759                       unsigned int offset, unsigned int len);
 760
 761 unsigned int lnet_kiov_nob (unsigned int niov, lnet_kiov_t *iov);
 762 int lnet_extract_kiov(int dst_niov, lnet_kiov_t *dst,
 763                      int src_niov, lnet_kiov_t *src,
 764                      unsigned int offset, unsigned int len);
 765
 766 void lnet_copy_iov2iov(unsigned int ndiov, struct kvec *diov,
 767                        unsigned int doffset,
 768                        unsigned int nsiov, struct kvec *siov,
 769                        unsigned int soffset, unsigned int nob);
 770 void lnet_copy_kiov2iov(unsigned int niov, struct kvec *iov,
 771                         unsigned int iovoffset,
 772                         unsigned int nkiov, lnet_kiov_t *kiov,
 773                         unsigned int kiovoffset, unsigned int nob);
 774 void lnet_copy_iov2kiov(unsigned int nkiov, lnet_kiov_t *kiov,
 775                         unsigned int kiovoffset,
 776                         unsigned int niov, struct kvec *iov,
 777                         unsigned int iovoffset, unsigned int nob);
 778 void lnet_copy_kiov2kiov(unsigned int ndkiov, lnet_kiov_t *dkiov,
 779                          unsigned int doffset,
 780                          unsigned int nskiov, lnet_kiov_t *skiov,
 781                          unsigned int soffset, unsigned int nob);
 782
 783 static inline void
 784 lnet_copy_iov2flat(int dlen, void *dest, unsigned int doffset,
 785                    unsigned int nsiov, struct kvec *siov, unsigned int soffset,
 786                    unsigned int nob)
 787 {
 788         struct kvec diov = { .iov_base = dest, .iov_len = dlen };
 789
 790         lnet_copy_iov2iov(1, &diov, doffset,
 791                           nsiov, siov, soffset, nob);
 792 }
 793
 794 static inline void
 795 lnet_copy_kiov2flat(int dlen, void *dest, unsigned int doffset,
 796                     unsigned int nsiov, lnet_kiov_t *skiov,
 797                     unsigned int soffset, unsigned int nob)
 798 {
 799         struct kvec diov = { .iov_base = dest, .iov_len = dlen };
 800
 801         lnet_copy_kiov2iov(1, &diov, doffset,
 802                            nsiov, skiov, soffset, nob);
 803 }
 804
 805 static inline void
 806 lnet_copy_flat2iov(unsigned int ndiov, struct kvec *diov, unsigned int doffset,
 807                    int slen, void *src, unsigned int soffset,
 808                    unsigned int nob)
 809 {
 810         struct kvec siov = { .iov_base = src, .iov_len = slen };
 811         lnet_copy_iov2iov(ndiov, diov, doffset,
 812                           1, &siov, soffset, nob);
 813 }
 814
 815 static inline void
 816 lnet_copy_flat2kiov(unsigned int ndiov, lnet_kiov_t *dkiov,
 817                     unsigned int doffset, int slen, void *src,
 818                     unsigned int soffset, unsigned int nob)
 819 {
 820         struct kvec siov = { .iov_base = src, .iov_len = slen };
 821         lnet_copy_iov2kiov(ndiov, dkiov, doffset,
 822                            1, &siov, soffset, nob);
 823 }
 824
 825 void lnet_me_unlink(struct lnet_me *me);
 826
 827 void lnet_md_unlink(struct lnet_libmd *md);
 828 void lnet_md_deconstruct(struct lnet_libmd *lmd, struct lnet_md *umd);
 829 struct page *lnet_kvaddr_to_page(unsigned long vaddr);
 830 int lnet_cpt_of_md(struct lnet_libmd *md, unsigned int offset);
 831
 832 unsigned int lnet_get_lnd_timeout(void);
 833 void lnet_register_lnd(struct lnet_lnd *lnd);
 834 void lnet_unregister_lnd(struct lnet_lnd *lnd);
 835
 836 int lnet_connect(struct socket **sockp, lnet_nid_t peer_nid,
 837                  __u32 local_ip, __u32 peer_ip, int peer_port, struct net *ns);
 838 void lnet_connect_console_error(int rc, lnet_nid_t peer_nid,
 839                                 __u32 peer_ip, int port);
 840 int lnet_count_acceptor_nets(void);
 841 int lnet_acceptor_timeout(void);
 842 int lnet_acceptor_port(void);
 843 int lnet_acceptor_start(void);
 844 void lnet_acceptor_stop(void);
 845
 846 struct lnet_inetdev {
 847         u32     li_cpt;
 848         u32     li_flags;
 849         u32     li_ipaddr;
 850         u32     li_netmask;
 851         char    li_name[IFNAMSIZ];
 852 };
 853
 854 int lnet_inet_enumerate(struct lnet_inetdev **dev_list, struct net *ns);
 855 int lnet_sock_setbuf(struct socket *socket, int txbufsize, int rxbufsize);
 856 int lnet_sock_getbuf(struct socket *socket, int *txbufsize, int *rxbufsize);
 857 int lnet_sock_getaddr(struct socket *socket, bool remote, __u32 *ip, int *port);
 858 int lnet_sock_write(struct socket *sock, void *buffer, int nob, int timeout);
 859 int lnet_sock_read(struct socket *sock, void *buffer, int nob, int timeout);
 860
 861 int lnet_sock_listen(struct socket **sockp, __u32 ip, int port, int backlog,
 862                      struct net *ns);
 863 int lnet_sock_accept(struct socket **newsockp, struct socket *sock);
 864 int lnet_sock_connect(struct socket **sockp, int *fatal,
 865                         __u32 local_ip, int local_port,
 866                         __u32 peer_ip, int peer_port, struct net *ns);
 867
 868 int lnet_peers_start_down(void);
 869 int lnet_peer_buffer_credits(struct lnet_net *net);
 870 void lnet_consolidate_routes_locked(struct lnet_peer *orig_lp,
 871                                     struct lnet_peer *new_lp);
 872 void lnet_router_discovery_complete(struct lnet_peer *lp);
 873 void lnet_router_discovery_ping_reply(struct lnet_peer *lp);
 874
 875 int lnet_monitor_thr_start(void);
 876 void lnet_monitor_thr_stop(void);
 877
 878 bool lnet_router_checker_active(void);
 879 void lnet_check_routers(void);
 880 void lnet_wait_router_start(void);
 881 void lnet_swap_pinginfo(struct lnet_ping_buffer *pbuf);
 882
 883 int lnet_ping_info_validate(struct lnet_ping_info *pinfo);
 884 struct lnet_ping_buffer *lnet_ping_buffer_alloc(int nnis, gfp_t gfp);
 885 void lnet_ping_buffer_free(struct lnet_ping_buffer *pbuf);
 886
 887 static inline void lnet_ping_buffer_addref(struct lnet_ping_buffer *pbuf)
 888 {
 889         atomic_inc(&pbuf->pb_refcnt);
 890 }
 891
 892 static inline void lnet_ping_buffer_decref(struct lnet_ping_buffer *pbuf)
 893 {
 894         if (atomic_dec_and_test(&pbuf->pb_refcnt))
 895                 lnet_ping_buffer_free(pbuf);
 896 }
 897
 898 static inline int lnet_ping_buffer_numref(struct lnet_ping_buffer *pbuf)
 899 {
 900         return atomic_read(&pbuf->pb_refcnt);
 901 }
 902
 903 static inline int lnet_push_target_resize_needed(void)
 904 {
 905         return the_lnet.ln_push_target->pb_nnis < the_lnet.ln_push_target_nnis;
 906 }
 907
 908 int lnet_push_target_resize(void);
 909 void lnet_peer_push_event(struct lnet_event *ev);
 910
 911 int lnet_parse_ip2nets(char **networksp, char *ip2nets);
 912 int lnet_parse_routes(char *route_str, int *im_a_router);
 913 int lnet_parse_networks(struct list_head *nilist, char *networks,
 914                         bool use_tcp_bonding);
 915 bool lnet_net_unique(__u32 net_id, struct list_head *nilist,
 916                      struct lnet_net **net);
 917 bool lnet_ni_unique_net(struct list_head *nilist, char *iface);
 918 void lnet_incr_dlc_seq(void);
 919 __u32 lnet_get_dlc_seq_locked(void);
 920 int lnet_get_net_count(void);
 921
 922 struct lnet_peer_net *lnet_get_next_peer_net_locked(struct lnet_peer *lp,
 923                                                     __u32 prev_lpn_id);
 924 struct lnet_peer_ni *lnet_get_next_peer_ni_locked(struct lnet_peer *peer,
 925                                                   struct lnet_peer_net *peer_net,
 926                                                   struct lnet_peer_ni *prev);
 927 struct lnet_peer_ni *lnet_nid2peerni_locked(lnet_nid_t nid, lnet_nid_t pref,
 928                                         int cpt);
 929 struct lnet_peer_ni *lnet_nid2peerni_ex(lnet_nid_t nid, int cpt);
 930 struct lnet_peer_ni *lnet_peer_get_ni_locked(struct lnet_peer *lp,
 931                                              lnet_nid_t nid);
 932 struct lnet_peer_ni *lnet_find_peer_ni_locked(lnet_nid_t nid);
 933 struct lnet_peer *lnet_find_peer(lnet_nid_t nid);
 934 void lnet_peer_net_added(struct lnet_net *net);
 935 lnet_nid_t lnet_peer_primary_nid_locked(lnet_nid_t nid);
 936 int lnet_discover_peer_locked(struct lnet_peer_ni *lpni, int cpt, bool block);
 937 int lnet_peer_discovery_start(void);
 938 void lnet_peer_discovery_stop(void);
 939 void lnet_push_update_to_peers(int force);
 940 void lnet_peer_tables_cleanup(struct lnet_net *net);
 941 void lnet_peer_uninit(void);
 942 int lnet_peer_tables_create(void);
 943 void lnet_debug_peer(lnet_nid_t nid);
 944 struct lnet_peer_net *lnet_peer_get_net_locked(struct lnet_peer *peer,
 945                                                __u32 net_id);
 946 bool lnet_peer_is_pref_nid_locked(struct lnet_peer_ni *lpni, lnet_nid_t nid);
 947 int lnet_peer_ni_set_non_mr_pref_nid(struct lnet_peer_ni *lpni, lnet_nid_t nid);
 948 int lnet_add_peer_ni(lnet_nid_t key_nid, lnet_nid_t nid, bool mr);
 949 int lnet_del_peer_ni(lnet_nid_t key_nid, lnet_nid_t nid);
 950 int lnet_get_peer_info(struct lnet_ioctl_peer_cfg *cfg, void __user *bulk);
 951 int lnet_get_peer_ni_info(__u32 peer_index, __u64 *nid,
 952                           char alivness[LNET_MAX_STR_LEN],
 953                           __u32 *cpt_iter, __u32 *refcount,
 954                           __u32 *ni_peer_tx_credits, __u32 *peer_tx_credits,
 955                           __u32 *peer_rtr_credits, __u32 *peer_min_rtr_credtis,
 956                           __u32 *peer_tx_qnob);
 957 int lnet_get_peer_ni_hstats(struct lnet_ioctl_peer_ni_hstats *stats);
 958
 959 static inline struct lnet_peer_net *
 960 lnet_find_peer_net_locked(struct lnet_peer *peer, __u32 net_id)
 961 {
 962         struct lnet_peer_net *peer_net;
 963
 964         list_for_each_entry(peer_net, &peer->lp_peer_nets, lpn_peer_nets) {
 965                 if (peer_net->lpn_net_id == net_id)
 966                         return peer_net;
 967         }
 968
 969         return NULL;
 970 }
 971
 972 static inline bool
 973 lnet_peer_is_multi_rail(struct lnet_peer *lp)
 974 {
 975         if (lp->lp_state & LNET_PEER_MULTI_RAIL)
 976                 return true;
 977         return false;
 978 }
 979
 980 static inline bool
 981 lnet_peer_ni_is_configured(struct lnet_peer_ni *lpni)
 982 {
 983         if (lpni->lpni_peer_net->lpn_peer->lp_state & LNET_PEER_CONFIGURED)
 984                 return true;
 985         return false;
 986 }
 987
 988 static inline bool
 989 lnet_peer_ni_is_primary(struct lnet_peer_ni *lpni)
 990 {
 991         return lpni->lpni_nid == lpni->lpni_peer_net->lpn_peer->lp_primary_nid;
 992 }
 993
 994 bool lnet_peer_is_uptodate(struct lnet_peer *lp);
 995 bool lnet_peer_is_uptodate_locked(struct lnet_peer *lp);
 996 bool lnet_is_discovery_disabled(struct lnet_peer *lp);
 997 bool lnet_peer_gw_discovery(struct lnet_peer *lp);
 998
 999 static inline bool
1000 lnet_peer_needs_push(struct lnet_peer *lp)
1001 {
1002         if (!(lp->lp_state & LNET_PEER_MULTI_RAIL))
1003                 return false;
1004         if (lp->lp_state & LNET_PEER_FORCE_PUSH)
1005                 return true;
1006         if (lp->lp_state & LNET_PEER_NO_DISCOVERY)
1007                 return false;
1008         /* if discovery is not enabled then no need to push */
1009         if (lnet_peer_discovery_disabled)
1010                 return false;
1011         if (lp->lp_node_seqno < atomic_read(&the_lnet.ln_ping_target_seqno))
1012                 return true;
1013         return false;
1014 }
1015
1016 /*
1017  * A peer is alive if it satisfies the following two conditions:
1018  *  1. peer health >= LNET_MAX_HEALTH_VALUE * router_sensitivity_percentage
1019  *  2. the cached NI status received when we discover the peer is UP
1020  */
1021 static inline bool
1022 lnet_is_peer_ni_alive(struct lnet_peer_ni *lpni)
1023 {
1024         bool halive = false;
1025
1026         halive = (atomic_read(&lpni->lpni_healthv) >=
1027                  (LNET_MAX_HEALTH_VALUE * router_sensitivity_percentage / 100));
1028
1029         return halive && lpni->lpni_ns_status == LNET_NI_STATUS_UP;
1030 }
1031
1032 static inline void
1033 lnet_set_healthv(atomic_t *healthv, int value)
1034 {
1035         atomic_set(healthv, value);
1036 }
1037
1038 static inline void
1039 lnet_inc_healthv(atomic_t *healthv)
1040 {
1041         atomic_add_unless(healthv, 1, LNET_MAX_HEALTH_VALUE);
1042 }
1043
1044 void lnet_incr_stats(struct lnet_element_stats *stats,
1045                      enum lnet_msg_type msg_type,
1046                      enum lnet_stats_type stats_type);
1047
1048 __u32 lnet_sum_stats(struct lnet_element_stats *stats,
1049                      enum lnet_stats_type stats_type);
1050
1051 void lnet_usr_translate_stats(struct lnet_ioctl_element_msg_stats *msg_stats,
1052                               struct lnet_element_stats *stats);
1053
1054 #endif