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

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