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