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