lnet/klnds/socklnd/socklnd.h

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