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