drivers/staging/lustre/lnet/klnds/socklnd/socklnd.h

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