lnet/klnds/socklnd/socklnd.h

   1 /*
   2  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
   3  *
   4  * Copyright (c) 2011, 2017, Intel Corporation.
   5  *
   6  *   Author: Zach Brown <zab@zabbo.net>
   7  *   Author: Peter J. Braam <braam@clusterfs.com>
   8  *   Author: Phil Schwan <phil@clusterfs.com>
   9  *   Author: Eric Barton <eric@bartonsoftware.com>
  10  *
  11  *   This file is part of Lustre, http://www.lustre.org
  12  *
  13  *   Portals is free software; you can redistribute it and/or
  14  *   modify it under the terms of version 2 of the GNU General Public
  15  *   License as published by the Free Software Foundation.
  16  *
  17  *   Portals is distributed in the hope that it will be useful,
  18  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  *   GNU General Public License for more details.
  21  *
  22  *   You should have received a copy of the GNU General Public License
  23  *   along with Portals; if not, write to the Free Software
  24  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  25  *
  26  */
  27
  28 #ifndef _SOCKLND_SOCKLND_H_
  29 #define _SOCKLND_SOCKLND_H_
  30
  31 #define DEBUG_PORTAL_ALLOC
  32 #define DEBUG_SUBSYSTEM S_LND
  33
  34 #include <linux/crc32.h>
  35 #include <linux/errno.h>
  36 #include <linux/if.h>
  37 #include <linux/init.h>
  38 #include <linux/kernel.h>
  39 #include <linux/kthread.h>
  40 #include <linux/kmod.h>
  41 #include <linux/list.h>
  42 #include <linux/mm.h>
  43 #include <linux/module.h>
  44 #include <linux/pagemap.h>
  45 #include <linux/stat.h>
  46 #include <linux/string.h>
  47 #include <linux/syscalls.h>
  48 #include <linux/sysctl.h>
  49 #include <linux/uio.h>
  50 #include <linux/unistd.h>
  51 #include <linux/hashtable.h>
  52 #include <net/sock.h>
  53 #include <net/tcp.h>
  54
  55 #include <lnet/lib-lnet.h>
  56 #include <lnet/socklnd.h>
  57
  58 #ifndef NETIF_F_CSUM_MASK
  59 # define NETIF_F_CSUM_MASK NETIF_F_ALL_CSUM
  60 #endif
  61
  62 /* assume one thread for each connection type */
  63 #define SOCKNAL_NSCHEDS         3
  64 #define SOCKNAL_NSCHEDS_HIGH    (SOCKNAL_NSCHEDS << 1)
  65
  66 #define SOCKNAL_PEER_HASH_BITS  7       /* log2 of # peer_ni lists */
  67 #define SOCKNAL_RESCHED         100     /* # scheduler loops before reschedule */
  68 #define SOCKNAL_INSANITY_RECONN 5000    /* connd is trying on reconn infinitely */
  69 #define SOCKNAL_ENOMEM_RETRY    1       /* seconds between retries */
  70
  71 #define SOCKNAL_SINGLE_FRAG_TX      0   /* disable multi-fragment sends */
  72 #define SOCKNAL_SINGLE_FRAG_RX      0   /* disable multi-fragment receives */
  73
  74 #define SOCKNAL_VERSION_DEBUG       0   /* enable protocol version debugging */
  75
  76 /* risk kmap deadlock on multi-frag I/O (backs off to single-frag if disabled).
  77  * no risk if we're not running on a CONFIG_HIGHMEM platform. */
  78 #ifdef CONFIG_HIGHMEM
  79 # define SOCKNAL_RISK_KMAP_DEADLOCK  0
  80 #else
  81 # define SOCKNAL_RISK_KMAP_DEADLOCK  1
  82 #endif
  83
  84 /* per scheduler state */
  85 struct ksock_sched {
  86         /* serialise */
  87         spinlock_t kss_lock;
  88         /* conn waiting to be written */
  89         struct list_head kss_rx_conns;
  90         struct list_head kss_tx_conns;
  91         /* zombie noop tx list */
  92         struct list_head kss_zombie_noop_txs;
  93         /* where scheduler sleeps */
  94         wait_queue_head_t kss_waitq;
  95         /* # connections assigned to this scheduler */
  96         int kss_nconns;
  97         /* max allowed threads */
  98         int kss_nthreads_max;
  99         /* number of threads */
 100         int kss_nthreads;
 101         /* CPT id */
 102         int kss_cpt;
 103 };
 104
 105 #define KSOCK_CPT_SHIFT                 16
 106 #define KSOCK_THREAD_ID(cpt, sid)       (((cpt) << KSOCK_CPT_SHIFT) | (sid))
 107 #define KSOCK_THREAD_CPT(id)            ((id) >> KSOCK_CPT_SHIFT)
 108 #define KSOCK_THREAD_SID(id)            ((id) & ((1UL << KSOCK_CPT_SHIFT) - 1))
 109
 110 struct ksock_interface {                        /* in-use interface */
 111         int             ksni_index;             /* Linux interface index */
 112         __u32           ksni_ipaddr;            /* interface's IP address */
 113         __u32           ksni_netmask;           /* interface's network mask */
 114         int             ksni_nroutes;           /* # routes using (active) */
 115         int             ksni_npeers;            /* # peers using (passive) */
 116         char            ksni_name[IFNAMSIZ];    /* interface name */
 117 };
 118
 119 struct ksock_tunables {
 120         /* "stuck" socket timeout (seconds) */
 121         int              *ksnd_timeout;
 122         /* # scheduler threads in each pool while starting */
 123         int              *ksnd_nscheds;
 124         int              *ksnd_nconnds;         /* # connection daemons */
 125         int              *ksnd_nconnds_max;     /* max # connection daemons */
 126         int              *ksnd_min_reconnectms; /* first connection retry after (ms)... */
 127         int              *ksnd_max_reconnectms; /* ...exponentially increasing to this */
 128         int              *ksnd_eager_ack;       /* make TCP ack eagerly? */
 129         int              *ksnd_typed_conns;     /* drive sockets by type? */
 130         int              *ksnd_min_bulk;        /* smallest "large" message */
 131         int              *ksnd_tx_buffer_size;  /* socket tx buffer size */
 132         int              *ksnd_rx_buffer_size;  /* socket rx buffer size */
 133         int              *ksnd_nagle;           /* enable NAGLE? */
 134         int              *ksnd_round_robin;     /* round robin for multiple interfaces */
 135         int              *ksnd_keepalive;       /* # secs for sending keepalive NOOP */
 136         int              *ksnd_keepalive_idle;  /* # idle secs before 1st probe */
 137         int              *ksnd_keepalive_count; /* # probes */
 138         int              *ksnd_keepalive_intvl; /* time between probes */
 139         int              *ksnd_credits;         /* # concurrent sends */
 140         int              *ksnd_peertxcredits;   /* # concurrent sends to 1 peer_ni */
 141         int              *ksnd_peerrtrcredits;  /* # per-peer_ni router buffer credits */
 142         int              *ksnd_peertimeout;     /* seconds to consider peer_ni dead */
 143         int              *ksnd_enable_csum;     /* enable check sum */
 144         int              *ksnd_inject_csum_error; /* set non-zero to inject checksum error */
 145         int              *ksnd_nonblk_zcack;    /* always send zc-ack on non-blocking connection */
 146         unsigned int     *ksnd_zc_min_payload;  /* minimum zero copy payload size */
 147         int              *ksnd_zc_recv;         /* enable ZC receive (for Chelsio TOE) */
 148         int              *ksnd_zc_recv_min_nfrags; /* minimum # of fragments to enable ZC receive */
 149         int              *ksnd_irq_affinity;    /* enable IRQ affinity? */
 150 #ifdef SOCKNAL_BACKOFF
 151         int              *ksnd_backoff_init;    /* initial TCP backoff */
 152         int              *ksnd_backoff_max;     /* maximum TCP backoff */
 153 #endif
 154 #if SOCKNAL_VERSION_DEBUG
 155         int              *ksnd_protocol;        /* protocol version */
 156 #endif
 157 };
 158
 159 struct ksock_net {
 160         __u64             ksnn_incarnation;     /* my epoch */
 161         struct list_head  ksnn_list;            /* chain on global list */
 162         atomic_t          ksnn_npeers;          /* # peers */
 163         int               ksnn_ninterfaces;     /* IP interfaces */
 164         struct ksock_interface ksnn_interfaces[LNET_INTERFACES_NUM];
 165 };
 166 /* When the ksock_net is shut down, this (negative) bias is added to
 167  * ksnn_npeers, which prevents new peers from being added.
 168  */
 169 #define SOCKNAL_SHUTDOWN_BIAS  (INT_MIN+1)
 170
 171 /** connd timeout */
 172 #define SOCKNAL_CONND_TIMEOUT  120
 173 /** reserved thread for accepting & creating new connd */
 174 #define SOCKNAL_CONND_RESV     1
 175
 176 struct ksock_nal_data {
 177         int                     ksnd_init;      /* initialisation state */
 178         int                     ksnd_nnets;     /* # networks set up */
 179         struct list_head        ksnd_nets;      /* list of nets */
 180         /* stabilize peer_ni/conn ops */
 181         rwlock_t                ksnd_global_lock;
 182         /* hash table of all my known peers */
 183         DECLARE_HASHTABLE(ksnd_peers, SOCKNAL_PEER_HASH_BITS);
 184
 185         int                     ksnd_nthreads;  /* # live threads */
 186         int                     ksnd_shuttingdown; /* tell threads to exit */
 187         /* schedulers information */
 188         struct ksock_sched      **ksnd_schedulers;
 189
 190         atomic_t      ksnd_nactive_txs;    /* #active txs */
 191
 192         /* conns to close: reaper_lock*/
 193         struct list_head        ksnd_deathrow_conns;
 194         /* conns to free: reaper_lock */
 195         struct list_head        ksnd_zombie_conns;
 196         /* conns to retry: reaper_lock*/
 197         struct list_head        ksnd_enomem_conns;
 198         /* reaper sleeps here */
 199         wait_queue_head_t       ksnd_reaper_waitq;
 200         /* when reaper will wake */
 201         time64_t                ksnd_reaper_waketime;
 202         /* serialise */
 203         spinlock_t        ksnd_reaper_lock;
 204
 205         int               ksnd_enomem_tx;      /* test ENOMEM sender */
 206         int               ksnd_stall_tx;       /* test sluggish sender */
 207         int               ksnd_stall_rx;       /* test sluggish receiver */
 208
 209         /* incoming connection requests */
 210         struct list_head        ksnd_connd_connreqs;
 211         /* routes waiting to be connected */
 212         struct list_head        ksnd_connd_routes;
 213         /* connds sleep here */
 214         wait_queue_head_t       ksnd_connd_waitq;
 215         /* # connds connecting */
 216         int                     ksnd_connd_connecting;
 217         /** time stamp of the last failed connecting attempt */
 218         time64_t                ksnd_connd_failed_stamp;
 219         /** # starting connd */
 220         unsigned                ksnd_connd_starting;
 221         /** time stamp of the last starting connd */
 222         time64_t                ksnd_connd_starting_stamp;
 223         /** # running connd */
 224         unsigned                ksnd_connd_running;
 225         /* serialise */
 226         spinlock_t              ksnd_connd_lock;
 227
 228         /* list head for freed noop tx */
 229         struct list_head        ksnd_idle_noop_txs;
 230         /* serialise, g_lock unsafe */
 231         spinlock_t              ksnd_tx_lock;
 232 };
 233
 234 #define SOCKNAL_INIT_NOTHING    0
 235 #define SOCKNAL_INIT_DATA       1
 236 #define SOCKNAL_INIT_ALL        2
 237
 238 /* A packet just assembled for transmission is represented by 1 or more
 239  * struct kvec fragments (the first frag contains the portals header),
 240  * followed by 0 or more struct bio_vec fragments.
 241  *
 242  * On the receive side, initially 1 struct kvec fragment is posted for
 243  * receive (the header).  Once the header has been received, the payload is
 244  * received into either struct kvec or struct bio_vec fragments, depending on
 245  * what the header matched or whether the message needs forwarding. */
 246
 247 struct ksock_conn;                              /* forward ref */
 248 struct ksock_route;                             /* forward ref */
 249 struct ksock_proto;                             /* forward ref */
 250
 251 struct ksock_tx {                       /* transmit packet */
 252         struct list_head   tx_list;     /* queue on conn for transmission etc */
 253         struct list_head   tx_zc_list;  /* queue on peer_ni for ZC request */
 254         atomic_t       tx_refcount;    /* tx reference count */
 255         int            tx_nob;         /* # packet bytes */
 256         int            tx_resid;       /* residual bytes */
 257         int            tx_niov;        /* # packet kvec frags */
 258         struct kvec  *tx_iov;         /* packet kvec frags */
 259         int            tx_nkiov;       /* # packet page frags */
 260         unsigned short tx_zc_aborted;  /* aborted ZC request */
 261         unsigned short tx_zc_capable:1; /* payload is large enough for ZC */
 262         unsigned short tx_zc_checked:1; /* Have I checked if I should ZC? */
 263         unsigned short tx_nonblk:1;    /* it's a non-blocking ACK */
 264         struct bio_vec *tx_kiov;        /* packet page frags */
 265         struct ksock_conn *tx_conn;     /* owning conn */
 266         struct lnet_msg *tx_lnetmsg;    /* lnet message for lnet_finalize() */
 267         time64_t        tx_deadline;    /* when (in secs) tx times out */
 268         struct ksock_msg tx_msg;        /* socklnd message buffer */
 269         int             tx_desc_size;   /* size of this descriptor */
 270         enum lnet_msg_hstatus tx_hstatus; /* health status of tx */
 271         struct kvec     tx_hdr;         /* virt hdr */
 272         struct bio_vec  tx_payload[0];  /* paged payload */
 273 };
 274
 275 #define KSOCK_NOOP_TX_SIZE  ((int)offsetof(struct ksock_tx, tx_payload[0]))
 276
 277 /* network zero copy callback descriptor embedded in struct ksock_tx */
 278
 279 /* space for the rx frag descriptors; we either read a single contiguous
 280  * header, or up to LNET_MAX_IOV frags of payload of either type. */
 281 union ksock_rxiovspace {
 282         struct kvec     iov[LNET_MAX_IOV];
 283         struct bio_vec  kiov[LNET_MAX_IOV];
 284 };
 285
 286 #define SOCKNAL_RX_KSM_HEADER   1               /* reading ksock message header */
 287 #define SOCKNAL_RX_LNET_HEADER  2               /* reading lnet message header */
 288 #define SOCKNAL_RX_PARSE        3               /* Calling lnet_parse() */
 289 #define SOCKNAL_RX_PARSE_WAIT   4               /* waiting to be told to read the body */
 290 #define SOCKNAL_RX_LNET_PAYLOAD 5               /* reading lnet payload (to deliver here) */
 291 #define SOCKNAL_RX_SLOP         6               /* skipping body */
 292
 293 struct ksock_conn {
 294         struct ksock_peer_ni    *ksnc_peer;     /* owning peer_ni */
 295         struct ksock_route      *ksnc_route;    /* owning route */
 296         struct list_head    ksnc_list;          /* stash on peer_ni's conn list */
 297         struct socket       *ksnc_sock;         /* actual socket */
 298         void                *ksnc_saved_data_ready; /* socket's original data_ready() callback */
 299         void                *ksnc_saved_write_space; /* socket's original write_space() callback */
 300         atomic_t            ksnc_conn_refcount; /* conn refcount */
 301         atomic_t            ksnc_sock_refcount; /* sock refcount */
 302         struct ksock_sched *ksnc_scheduler;     /* who schedules this connection */
 303         __u32               ksnc_myipaddr;   /* my IP */
 304         __u32               ksnc_ipaddr;     /* peer_ni's IP */
 305         int                 ksnc_port;       /* peer_ni's port */
 306         signed int          ksnc_type:3;     /* type of connection,
 307                                               * should be signed value */
 308         unsigned int        ksnc_closing:1;  /* being shut down */
 309         unsigned int        ksnc_flip:1;     /* flip or not, only for V2.x */
 310         unsigned int        ksnc_zc_capable:1; /* enable to ZC */
 311         const struct ksock_proto *ksnc_proto; /* protocol for the connection */
 312
 313         /* READER */
 314
 315         /* where I enq waiting input or a forwarding descriptor */
 316         struct list_head   ksnc_rx_list;
 317         time64_t                ksnc_rx_deadline; /* when (in seconds) receive times out */
 318         __u8                  ksnc_rx_started;  /* started receiving a message */
 319         __u8                  ksnc_rx_ready;    /* data ready to read */
 320         __u8                  ksnc_rx_scheduled;/* being progressed */
 321         __u8                  ksnc_rx_state;    /* what is being read */
 322         int                   ksnc_rx_nob_left; /* # bytes to next hdr/body */
 323         int                   ksnc_rx_nob_wanted; /* bytes actually wanted */
 324         int                   ksnc_rx_niov;     /* # kvec frags */
 325         struct kvec          *ksnc_rx_iov;      /* the kvec frags */
 326         int                   ksnc_rx_nkiov;    /* # page frags */
 327         struct bio_vec       *ksnc_rx_kiov;     /* the page frags */
 328         union ksock_rxiovspace  ksnc_rx_iov_space;/* space for frag descriptors */
 329         __u32                 ksnc_rx_csum;     /* partial checksum for incoming
 330                                                  * data */
 331         struct lnet_msg      *ksnc_lnet_msg;    /* rx lnet_finalize arg*/
 332         struct ksock_msg        ksnc_msg;       /* incoming message buffer:
 333                                                  * V2.x message takes the
 334                                                  * whole struct
 335                                                  * V1.x message is a bare
 336                                                  * struct lnet_hdr, it's stored
 337                                                  * in ksnc_msg.ksm_u.lnetmsg
 338                                                  */
 339         /* -- WRITER -- */
 340         /* where I enq waiting for output space */
 341         struct list_head        ksnc_tx_list;
 342         /* packets waiting to be sent */
 343         struct list_head        ksnc_tx_queue;
 344         /* next TX that can carry a LNet message or ZC-ACK */
 345         struct ksock_tx         *ksnc_tx_carrier;
 346         /* when (in seconds) tx times out */
 347         time64_t                ksnc_tx_deadline;
 348         /* send buffer marker */
 349         int                     ksnc_tx_bufnob;
 350         /* # bytes queued */
 351         atomic_t                ksnc_tx_nob;
 352         /* write space */
 353         int                     ksnc_tx_ready;
 354         /* being progressed */
 355         int                     ksnc_tx_scheduled;
 356         /* time stamp of the last posted TX */
 357         time64_t                ksnc_tx_last_post;
 358 };
 359
 360 struct ksock_route {
 361         struct list_head        ksnr_list;      /* chain on peer_ni route list*/
 362         struct list_head        ksnr_connd_list;/* chain on ksnr_connd_routes */
 363         struct ksock_peer_ni   *ksnr_peer;      /* owning peer_ni */
 364         atomic_t                ksnr_refcount;  /* # users */
 365         time64_t                ksnr_timeout;   /* when (in secs) reconnection
 366                                                  * can happen next
 367                                                  */
 368         time64_t                ksnr_retry_interval;/* secs between retries */
 369         int                     ksnr_myiface;   /* interface index */
 370         __u32                   ksnr_ipaddr;    /* IP address to connect to */
 371         int                     ksnr_port;      /* port to connect to */
 372         unsigned int            ksnr_scheduled:1;/* scheduled for attention */
 373         unsigned int            ksnr_connecting:1;/* connection in progress */
 374         unsigned int            ksnr_connected:4;/* connections by type */
 375         unsigned int            ksnr_deleted:1; /* been removed from peer_ni? */
 376         unsigned int            ksnr_share_count;/* created explicitly? */
 377         int                     ksnr_conn_count;/* # conns for this route */
 378 };
 379
 380 #define SOCKNAL_KEEPALIVE_PING          1       /* cookie for keepalive ping */
 381
 382 struct ksock_peer_ni {
 383         struct hlist_node       ksnp_list;      /* stash on global peer_ni list */
 384         time64_t                ksnp_last_alive;/* when (in seconds) I was last alive */
 385         struct lnet_process_id  ksnp_id;        /* who's on the other end(s) */
 386         atomic_t                ksnp_refcount;  /* # users */
 387         int                     ksnp_closing;   /* being closed */
 388         int                     ksnp_accepting; /* # passive connections pending */
 389         int                     ksnp_error;     /* errno on closing last conn */
 390         __u64                   ksnp_zc_next_cookie;/* ZC completion cookie */
 391         __u64                   ksnp_incarnation;   /* latest known peer_ni incarnation */
 392         const struct ksock_proto *ksnp_proto;   /* latest known protocol */
 393         struct list_head        ksnp_conns;     /* all active connections */
 394         struct list_head        ksnp_routes;    /* routes */
 395         struct list_head        ksnp_tx_queue;  /* waiting packets */
 396         spinlock_t              ksnp_lock;      /* serialize, g_lock unsafe */
 397         /* zero copy requests wait for ACK  */
 398         struct list_head        ksnp_zc_req_list;
 399         time64_t                ksnp_send_keepalive; /* time to send keepalive */
 400         struct lnet_ni          *ksnp_ni;       /* which network */
 401         int                     ksnp_n_passive_ips; /* # of... */
 402         __u32                   ksnp_passive_ips[LNET_INTERFACES_NUM]; /* preferred local interfaces */
 403 };
 404
 405 struct ksock_connreq {
 406         /* stash on ksnd_connd_connreqs */
 407         struct list_head        ksncr_list;
 408         /* chosen NI */
 409         struct lnet_ni          *ksncr_ni;
 410         /* accepted socket */
 411         struct socket           *ksncr_sock;
 412 };
 413
 414 extern struct ksock_nal_data ksocknal_data;
 415 extern struct ksock_tunables ksocknal_tunables;
 416
 417 #define SOCKNAL_MATCH_NO        0        /* TX can't match type of connection */
 418 #define SOCKNAL_MATCH_YES       1        /* TX matches type of connection */
 419 #define SOCKNAL_MATCH_MAY       2        /* TX can be sent on the connection, but not preferred */
 420
 421 struct ksock_proto {
 422         int           pro_version;                                              /* version number of protocol */
 423         int         (*pro_send_hello)(struct ksock_conn *, struct ksock_hello_msg *);     /* handshake function */
 424         int         (*pro_recv_hello)(struct ksock_conn *, struct ksock_hello_msg *, int);/* handshake function */
 425         void        (*pro_pack)(struct ksock_tx *);                                  /* message pack */
 426         void        (*pro_unpack)(struct ksock_msg *);                          /* message unpack */
 427         struct ksock_tx *(*pro_queue_tx_msg)(struct ksock_conn *, struct ksock_tx *);          /* queue tx on the connection */
 428         int         (*pro_queue_tx_zcack)(struct ksock_conn *, struct ksock_tx *, __u64); /* queue ZC ack on the connection */
 429         int         (*pro_handle_zcreq)(struct ksock_conn *, __u64, int);            /* handle ZC request */
 430         int         (*pro_handle_zcack)(struct ksock_conn *, __u64, __u64);          /* handle ZC ACK */
 431         int         (*pro_match_tx)(struct ksock_conn *, struct ksock_tx *, int);         /* msg type matches the connection type:
 432                                                                                  * return value:
 433                                                                                  *   return MATCH_NO  : no
 434                                                                                  *   return MATCH_YES : matching type
 435                                                                                  *   return MATCH_MAY : can be backup */
 436 };
 437
 438 extern const struct ksock_proto ksocknal_protocol_v1x;
 439 extern const struct ksock_proto ksocknal_protocol_v2x;
 440 extern const struct ksock_proto ksocknal_protocol_v3x;
 441
 442 #define KSOCK_PROTO_V1_MAJOR    LNET_PROTO_TCP_VERSION_MAJOR
 443 #define KSOCK_PROTO_V1_MINOR    LNET_PROTO_TCP_VERSION_MINOR
 444 #define KSOCK_PROTO_V1          KSOCK_PROTO_V1_MAJOR
 445
 446 #ifndef CPU_MASK_NONE
 447 #define CPU_MASK_NONE   0UL
 448 #endif
 449
 450 static inline __u32 ksocknal_csum(__u32 crc, unsigned char const *p, size_t len)
 451 {
 452 #if 1
 453         return crc32_le(crc, p, len);
 454 #else
 455         while (len-- > 0)
 456                 crc = ((crc + 0x100) & ~0xff) | ((crc + *p++) & 0xff) ;
 457
 458         return crc;
 459 #endif
 460 }
 461
 462 static inline int
 463 ksocknal_route_mask(void)
 464 {
 465         if (!*ksocknal_tunables.ksnd_typed_conns)
 466                 return BIT(SOCKLND_CONN_ANY);
 467
 468         return (BIT(SOCKLND_CONN_CONTROL) |
 469                 BIT(SOCKLND_CONN_BULK_IN) |
 470                 BIT(SOCKLND_CONN_BULK_OUT));
 471 }
 472
 473 static inline void
 474 ksocknal_conn_addref(struct ksock_conn *conn)
 475 {
 476         LASSERT(atomic_read(&conn->ksnc_conn_refcount) > 0);
 477         atomic_inc(&conn->ksnc_conn_refcount);
 478 }
 479
 480 extern void ksocknal_queue_zombie_conn(struct ksock_conn *conn);
 481 extern void ksocknal_finalize_zcreq(struct ksock_conn *conn);
 482
 483 static inline void
 484 ksocknal_conn_decref(struct ksock_conn *conn)
 485 {
 486         LASSERT(atomic_read(&conn->ksnc_conn_refcount) > 0);
 487         if (atomic_dec_and_test(&conn->ksnc_conn_refcount))
 488                 ksocknal_queue_zombie_conn(conn);
 489 }
 490
 491 static inline int
 492 ksocknal_connsock_addref(struct ksock_conn *conn)
 493 {
 494         int rc = -ESHUTDOWN;
 495
 496         read_lock(&ksocknal_data.ksnd_global_lock);
 497         if (!conn->ksnc_closing) {
 498                 LASSERT(atomic_read(&conn->ksnc_sock_refcount) > 0);
 499                 atomic_inc(&conn->ksnc_sock_refcount);
 500                 rc = 0;
 501         }
 502         read_unlock(&ksocknal_data.ksnd_global_lock);
 503
 504         return (rc);
 505 }
 506
 507 static inline void
 508 ksocknal_connsock_decref(struct ksock_conn *conn)
 509 {
 510         LASSERT(atomic_read(&conn->ksnc_sock_refcount) > 0);
 511         if (atomic_dec_and_test(&conn->ksnc_sock_refcount)) {
 512                 LASSERT (conn->ksnc_closing);
 513                 sock_release(conn->ksnc_sock);
 514                 conn->ksnc_sock = NULL;
 515                 ksocknal_finalize_zcreq(conn);
 516         }
 517 }
 518
 519 static inline void
 520 ksocknal_tx_addref(struct ksock_tx *tx)
 521 {
 522         LASSERT(atomic_read(&tx->tx_refcount) > 0);
 523         atomic_inc(&tx->tx_refcount);
 524 }
 525
 526 extern void ksocknal_tx_prep(struct ksock_conn *, struct ksock_tx *tx);
 527 extern void ksocknal_tx_done(struct lnet_ni *ni, struct ksock_tx *tx, int error);
 528
 529 static inline void
 530 ksocknal_tx_decref(struct ksock_tx *tx)
 531 {
 532         LASSERT(atomic_read(&tx->tx_refcount) > 0);
 533         if (atomic_dec_and_test(&tx->tx_refcount))
 534                 ksocknal_tx_done(NULL, tx, 0);
 535 }
 536
 537 static inline void
 538 ksocknal_route_addref(struct ksock_route *route)
 539 {
 540         LASSERT(atomic_read(&route->ksnr_refcount) > 0);
 541         atomic_inc(&route->ksnr_refcount);
 542 }
 543
 544 extern void ksocknal_destroy_route(struct ksock_route *route);
 545
 546 static inline void
 547 ksocknal_route_decref(struct ksock_route *route)
 548 {
 549         LASSERT(atomic_read(&route->ksnr_refcount) > 0);
 550         if (atomic_dec_and_test(&route->ksnr_refcount))
 551                 ksocknal_destroy_route (route);
 552 }
 553
 554 static inline void
 555 ksocknal_peer_addref(struct ksock_peer_ni *peer_ni)
 556 {
 557         LASSERT(atomic_read(&peer_ni->ksnp_refcount) > 0);
 558         atomic_inc(&peer_ni->ksnp_refcount);
 559 }
 560
 561 extern void ksocknal_destroy_peer(struct ksock_peer_ni *peer_ni);
 562
 563 static inline void
 564 ksocknal_peer_decref(struct ksock_peer_ni *peer_ni)
 565 {
 566         LASSERT (atomic_read (&peer_ni->ksnp_refcount) > 0);
 567         if (atomic_dec_and_test(&peer_ni->ksnp_refcount))
 568                 ksocknal_destroy_peer(peer_ni);
 569 }
 570
 571 int ksocknal_startup(struct lnet_ni *ni);
 572 void ksocknal_shutdown(struct lnet_ni *ni);
 573 int ksocknal_ctl(struct lnet_ni *ni, unsigned int cmd, void *arg);
 574 int ksocknal_send(struct lnet_ni *ni, void *private, struct lnet_msg *lntmsg);
 575 int ksocknal_recv(struct lnet_ni *ni, void *private, struct lnet_msg *lntmsg,
 576                   int delayed, unsigned int niov,
 577                   struct bio_vec *kiov,
 578                   unsigned int offset, unsigned int mlen, unsigned int rlen);
 579 int ksocknal_accept(struct lnet_ni *ni, struct socket *sock);
 580
 581 int ksocknal_add_peer(struct lnet_ni *ni, struct lnet_process_id id, __u32 ip,
 582                       int port);
 583 struct ksock_peer_ni *ksocknal_find_peer_locked(struct lnet_ni *ni,
 584                                            struct lnet_process_id id);
 585 struct ksock_peer_ni *ksocknal_find_peer(struct lnet_ni *ni,
 586                                     struct lnet_process_id id);
 587 extern void ksocknal_peer_failed(struct ksock_peer_ni *peer_ni);
 588 extern int ksocknal_create_conn(struct lnet_ni *ni, struct ksock_route *route,
 589                                 struct socket *sock, int type);
 590 extern void ksocknal_close_conn_locked(struct ksock_conn *conn, int why);
 591 extern void ksocknal_terminate_conn(struct ksock_conn *conn);
 592 extern void ksocknal_destroy_conn(struct ksock_conn *conn);
 593 extern int  ksocknal_close_peer_conns_locked(struct ksock_peer_ni *peer_ni,
 594                                              __u32 ipaddr, int why);
 595 extern int ksocknal_close_conn_and_siblings(struct ksock_conn *conn, int why);
 596 int ksocknal_close_matching_conns(struct lnet_process_id id, __u32 ipaddr);
 597 extern struct ksock_conn *ksocknal_find_conn_locked(struct ksock_peer_ni *peer_ni,
 598                                                     struct ksock_tx *tx, int nonblk);
 599
 600 extern int  ksocknal_launch_packet(struct lnet_ni *ni, struct ksock_tx *tx,
 601                                    struct lnet_process_id id);
 602 extern struct ksock_tx *ksocknal_alloc_tx(int type, int size);
 603 extern void ksocknal_free_tx(struct ksock_tx *tx);
 604 extern struct ksock_tx *ksocknal_alloc_tx_noop(__u64 cookie, int nonblk);
 605 extern void ksocknal_next_tx_carrier(struct ksock_conn *conn);
 606 extern void ksocknal_queue_tx_locked(struct ksock_tx *tx, struct ksock_conn *conn);
 607 extern void ksocknal_txlist_done(struct lnet_ni *ni, struct list_head *txlist,
 608                                  int error);
 609 extern void ksocknal_notify(lnet_nid_t gw_nid);
 610 extern void ksocknal_query(struct lnet_ni *ni, lnet_nid_t nid, time64_t *when);
 611 extern int ksocknal_thread_start(int (*fn)(void *arg), void *arg, char *name);
 612 extern void ksocknal_thread_fini(void);
 613 extern void ksocknal_launch_all_connections_locked(struct ksock_peer_ni *peer_ni);
 614 extern struct ksock_route *ksocknal_find_connectable_route_locked(struct ksock_peer_ni *peer_ni);
 615 extern struct ksock_route *ksocknal_find_connecting_route_locked(struct ksock_peer_ni *peer_ni);
 616 extern int ksocknal_new_packet(struct ksock_conn *conn, int skip);
 617 extern int ksocknal_scheduler(void *arg);
 618 extern int ksocknal_connd(void *arg);
 619 extern int ksocknal_reaper(void *arg);
 620 int ksocknal_send_hello(struct lnet_ni *ni, struct ksock_conn *conn,
 621                         lnet_nid_t peer_nid, struct ksock_hello_msg *hello);
 622 int ksocknal_recv_hello(struct lnet_ni *ni, struct ksock_conn *conn,
 623                         struct ksock_hello_msg *hello,
 624                         struct lnet_process_id *id,
 625                         __u64 *incarnation);
 626 extern void ksocknal_read_callback(struct ksock_conn *conn);
 627 extern void ksocknal_write_callback(struct ksock_conn *conn);
 628
 629 extern int ksocknal_lib_zc_capable(struct ksock_conn *conn);
 630 extern void ksocknal_lib_save_callback(struct socket *sock, struct ksock_conn *conn);
 631 extern void ksocknal_lib_set_callback(struct socket *sock,  struct ksock_conn *conn);
 632 extern void ksocknal_lib_reset_callback(struct socket *sock,
 633                                         struct ksock_conn *conn);
 634 extern void ksocknal_lib_push_conn(struct ksock_conn *conn);
 635 extern int ksocknal_lib_get_conn_addrs(struct ksock_conn *conn);
 636 extern int ksocknal_lib_setup_sock(struct socket *so);
 637 extern int ksocknal_lib_send_iov(struct ksock_conn *conn, struct ksock_tx *tx,
 638                                  struct kvec *scratch_iov);
 639 extern int ksocknal_lib_send_kiov(struct ksock_conn *conn, struct ksock_tx *tx,
 640                                   struct kvec *scratch_iov);
 641 extern void ksocknal_lib_eager_ack(struct ksock_conn *conn);
 642 extern int ksocknal_lib_recv_iov(struct ksock_conn *conn,
 643                                  struct kvec *scratchiov);
 644 extern int ksocknal_lib_recv_kiov(struct ksock_conn *conn, struct page **pages,
 645                        struct kvec *scratchiov);
 646 extern int ksocknal_lib_get_conn_tunables(struct ksock_conn *conn, int *txmem,
 647                                           int *rxmem, int *nagle);
 648
 649 extern int ksocknal_tunables_init(void);
 650
 651 extern void ksocknal_lib_csum_tx(struct ksock_tx *tx);
 652
 653 extern int ksocknal_lib_memory_pressure(struct ksock_conn *conn);
 654 extern int ksocknal_lib_bind_thread_to_cpu(int id);
 655
 656 #endif /* _SOCKLND_SOCKLND_H_ */