lnet/klnds/socklnd/socklnd.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * Copyright (C) 2001, 2002 Cluster File Systems, Inc.
   5  *   Author: Zach Brown <zab@zabbo.net>
   6  *   Author: Peter J. Braam <braam@clusterfs.com>
   7  *   Author: Phil Schwan <phil@clusterfs.com>
   8  *   Author: Eric Barton <eric@bartonsoftware.com>
   9  *
  10  *   This file is part of Portals, http://www.sf.net/projects/lustre/
  11  *
  12  *   Portals is free software; you can redistribute it and/or
  13  *   modify it under the terms of version 2 of the GNU General Public
  14  *   License as published by the Free Software Foundation.
  15  *
  16  *   Portals is distributed in the hope that it will be useful,
  17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  *   GNU General Public License for more details.
  20  *
  21  *   You should have received a copy of the GNU General Public License
  22  *   along with Portals; if not, write to the Free Software
  23  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  24  *
  25  */
  26
  27 #define DEBUG_PORTAL_ALLOC
  28 #define EXPORT_SYMTAB
  29
  30 #include <linux/config.h>
  31 #include <linux/module.h>
  32 #include <linux/kernel.h>
  33 #include <linux/mm.h>
  34 #include <linux/string.h>
  35 #include <linux/stat.h>
  36 #include <linux/errno.h>
  37 #include <linux/smp_lock.h>
  38 #include <linux/unistd.h>
  39 #include <net/sock.h>
  40 #include <net/tcp.h>
  41 #include <linux/uio.h>
  42
  43 #include <asm/system.h>
  44 #include <asm/uaccess.h>
  45
  46 #include <linux/fs.h>
  47 #include <linux/file.h>
  48 #include <linux/stat.h>
  49 #include <linux/list.h>
  50 #include <linux/kmod.h>
  51 #include <linux/sysctl.h>
  52 #include <asm/uaccess.h>
  53 #include <asm/segment.h>
  54 #include <asm/div64.h>
  55
  56 #define DEBUG_SUBSYSTEM S_SOCKNAL
  57
  58 #include <linux/kp30.h>
  59 #include <portals/p30.h>
  60 #include <portals/lib-p30.h>
  61
  62 #if CONFIG_SMP
  63 # define SOCKNAL_N_SCHED        smp_num_cpus    /* # socknal schedulers */
  64 #else
  65 # define SOCKNAL_N_SCHED        1               /* # socknal schedulers */
  66 #endif
  67 #define SOCKNAL_N_AUTOCONNECTD  4               /* # socknal autoconnect daemons */
  68
  69 #define SOCKNAL_MIN_RECONNECT_INTERVAL  HZ      /* first failed connection retry... */
  70 #define SOCKNAL_MAX_RECONNECT_INTERVAL  (60*HZ) /* ...exponentially increasing to this */
  71
  72 /* default vals for runtime tunables */
  73 #define SOCKNAL_IO_TIMEOUT       50             /* default comms timeout (seconds) */
  74 #define SOCKNAL_EAGER_ACK        1              /* default eager ack (boolean) */
  75 #define SOCKNAL_ZC_MIN_FRAG     (2<<10)         /* default smallest zerocopy fragment */
  76
  77 #define SOCKNAL_USE_KEEPALIVES   0              /* use tcp/ip keepalive? */
  78
  79 #define SOCKNAL_PEER_HASH_SIZE   101            /* # peer lists */
  80
  81 #if PTL_LARGE_MTU
  82 # define SOCKNAL_MAX_FWD_PAYLOAD (256<<10)      /* biggest payload I can forward */
  83 #else
  84 # define SOCKNAL_MAX_FWD_PAYLOAD (64<<10)       /* biggest payload I can forward */
  85 #endif
  86
  87 #define SOCKNAL_NLTXS           128             /* # normal transmit messages */
  88 #define SOCKNAL_NNBLK_LTXS      128             /* # transmit messages reserved if can't block */
  89
  90 #define SOCKNAL_SMALL_FWD_NMSGS 128             /* # small messages I can be forwarding at any time */
  91 #define SOCKNAL_LARGE_FWD_NMSGS 64              /* # large messages I can be forwarding at any time */
  92
  93 #define SOCKNAL_SMALL_FWD_PAGES 1               /* # pages in a small message fwd buffer */
  94
  95 #define SOCKNAL_LARGE_FWD_PAGES (PAGE_ALIGN (sizeof (ptl_hdr_t) + SOCKNAL_MAX_FWD_PAYLOAD) >> PAGE_SHIFT)
  96                                                 /* # pages in a large message fwd buffer */
  97
  98 #define SOCKNAL_RESCHED         100             /* # scheduler loops before reschedule */
  99
 100 #define SOCKNAL_TX_LOW_WATER(sk) (((sk)->sk_sndbuf*8)/10)
 101
 102 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,72))
 103 # define sk_data_ready  data_ready
 104 # define sk_write_space write_space
 105 # define sk_user_data   user_data
 106 # define sk_prot        prot
 107 # define sk_sndbuf      sndbuf
 108 # define sk_socket      socket
 109 #endif
 110
 111 typedef struct                                  /* pool of forwarding buffers */
 112 {
 113         spinlock_t        fmp_lock;             /* serialise */
 114         struct list_head  fmp_idle_fmbs;        /* buffers waiting for a connection */
 115         struct list_head  fmp_blocked_conns;    /* connections waiting for a buffer */
 116 } ksock_fmb_pool_t;
 117
 118
 119 typedef struct                                  /* per scheduler state */
 120 {
 121         spinlock_t        kss_lock;             /* serialise */
 122         struct list_head  kss_rx_conns;         /* conn waiting to be read */
 123         struct list_head  kss_tx_conns;         /* conn waiting to be written */
 124 #if SOCKNAL_ZC
 125         struct list_head  kss_zctxdone_list;    /* completed ZC transmits */
 126 #endif
 127         wait_queue_head_t kss_waitq;            /* where scheduler sleeps */
 128         int               kss_nconns;           /* # connections assigned to this scheduler */
 129 } ksock_sched_t;
 130
 131 typedef struct {
 132         int               ksni_valid:1;         /* been set yet? */
 133         int               ksni_bound:1;         /* bound to a cpu yet? */
 134         int               ksni_sched:6;         /* which scheduler (assumes < 64) */
 135 } ksock_irqinfo_t;
 136
 137 typedef struct {
 138         int               ksnd_init;            /* initialisation state */
 139         int               ksnd_io_timeout;      /* "stuck" socket timeout (seconds) */
 140         int               ksnd_eager_ack;       /* make TCP ack eagerly? */
 141 #if SOCKNAL_ZC
 142         unsigned int      ksnd_zc_min_frag;     /* minimum zero copy frag size */
 143 #endif
 144         struct ctl_table_header *ksnd_sysctl;   /* sysctl interface */
 145
 146         rwlock_t          ksnd_global_lock;     /* stabilize peer/conn ops */
 147         struct list_head *ksnd_peers;           /* hash table of all my known peers */
 148         int               ksnd_peer_hash_size;  /* size of ksnd_peers */
 149
 150         nal_cb_t         *ksnd_nal_cb;
 151         spinlock_t        ksnd_nal_cb_lock;     /* lib cli/sti lock */
 152
 153         atomic_t          ksnd_nthreads;        /* # live threads */
 154         int               ksnd_shuttingdown;    /* tell threads to exit */
 155         ksock_sched_t    *ksnd_schedulers;      /* scheduler state */
 156
 157         atomic_t          ksnd_npeers;          /* total # peers extant */
 158         atomic_t          ksnd_nclosing_conns;  /* # closed conns extant */
 159
 160         kpr_router_t      ksnd_router;          /* THE router */
 161
 162         void             *ksnd_fmbs;            /* all the pre-allocated FMBs */
 163         ksock_fmb_pool_t  ksnd_small_fmp;       /* small message forwarding buffers */
 164         ksock_fmb_pool_t  ksnd_large_fmp;       /* large message forwarding buffers */
 165
 166         void             *ksnd_ltxs;            /* all the pre-allocated LTXs */
 167         spinlock_t        ksnd_idle_ltx_lock;   /* serialise ltx alloc/free */
 168         struct list_head  ksnd_idle_ltx_list;   /* where to get an idle LTX */
 169         struct list_head  ksnd_idle_nblk_ltx_list; /* where to get an idle LTX if you can't block */
 170         wait_queue_head_t ksnd_idle_ltx_waitq;  /* where to block for an idle LTX */
 171         int               ksnd_active_ltxs;     /* #active ltxs */
 172
 173         struct list_head  ksnd_deathrow_conns;  /* conns to be closed */
 174         struct list_head  ksnd_zombie_conns;    /* conns to be freed */
 175         wait_queue_head_t ksnd_reaper_waitq;    /* reaper sleep here */
 176         spinlock_t        ksnd_reaper_lock;     /* serialise */
 177
 178         int               ksnd_stall_tx;        /* test sluggish sender */
 179         int               ksnd_stall_rx;        /* test sluggish receiver */
 180
 181         struct list_head  ksnd_autoconnectd_routes; /* routes waiting to be connected */
 182         wait_queue_head_t ksnd_autoconnectd_waitq; /* autoconnectds sleep here */
 183         spinlock_t        ksnd_autoconnectd_lock; /* serialise */
 184
 185         ksock_irqinfo_t   ksnd_irqinfo[NR_IRQS];/* irq->scheduler lookup */
 186 } ksock_nal_data_t;
 187
 188 #define SOCKNAL_INIT_NOTHING    0
 189 #define SOCKNAL_INIT_DATA       1
 190 #define SOCKNAL_INIT_PTL        2
 191 #define SOCKNAL_INIT_ALL        3
 192
 193 /* A packet just assembled for transmission is represented by 1 or more
 194  * struct iovec fragments and 0 or more ptl_kiov_t fragments.  Forwarded
 195  * messages, or messages from an MD with PTL_MD_KIOV _not_ set have 0
 196  * ptl_kiov_t fragments.  Messages from an MD with PTL_MD_KIOV set, have 1
 197  * struct iovec fragment (the header) and up to PTL_MD_MAX_IOV ptl_kiov_t
 198  * fragments.
 199  *
 200  * On the receive side, initially 1 struct iovec fragment is posted for
 201  * receive (the header).  Once the header has been received, if the message
 202  * requires forwarding or will be received into mapped memory, up to
 203  * PTL_MD_MAX_IOV struct iovec fragments describe the target memory.
 204  * Otherwise up to PTL_MD_MAX_IOV ptl_kiov_t fragments are used.
 205  */
 206
 207 struct ksock_conn;                              /* forward ref */
 208 struct ksock_peer;                              /* forward ref */
 209 struct ksock_route;                             /* forward ref */
 210
 211 typedef struct                                  /* transmit packet */
 212 {
 213         struct list_head        tx_list;        /* queue on conn for transmission etc */
 214         char                    tx_isfwd;       /* forwarding / sourced here */
 215         int                     tx_nob;         /* # packet bytes */
 216         int                     tx_resid;       /* residual bytes */
 217         int                     tx_niov;        /* # packet iovec frags */
 218         struct iovec           *tx_iov;         /* packet iovec frags */
 219         int                     tx_nkiov;       /* # packet page frags */
 220         ptl_kiov_t             *tx_kiov;        /* packet page frags */
 221         struct ksock_conn      *tx_conn;        /* owning conn */
 222         ptl_hdr_t              *tx_hdr;         /* packet header (for debug only) */
 223 #if SOCKNAL_ZC
 224         zccd_t                  tx_zccd;        /* zero copy callback descriptor */
 225 #endif
 226 } ksock_tx_t;
 227
 228 #define KSOCK_ZCCD_2_TX(ptr)    list_entry (ptr, ksock_tx_t, tx_zccd)
 229 /* network zero copy callback descriptor embedded in ksock_tx_t */
 230
 231 /* space for the tx frag descriptors: hdr is always 1 iovec
 232  * and payload is PTL_MD_MAX of either type. */
 233 typedef struct
 234 {
 235         struct iovec            hdr;
 236         union {
 237                 struct iovec    iov[PTL_MD_MAX_IOV];
 238                 ptl_kiov_t      kiov[PTL_MD_MAX_IOV];
 239         }                       payload;
 240 } ksock_txiovspace_t;
 241
 242 typedef struct                                  /* locally transmitted packet */
 243 {
 244         ksock_tx_t              ltx_tx;         /* send info */
 245         struct list_head       *ltx_idle;       /* where to put when idle */
 246         void                   *ltx_private;    /* lib_finalize() callback arg */
 247         void                   *ltx_cookie;     /* lib_finalize() callback arg */
 248         ksock_txiovspace_t      ltx_iov_space;  /* where to stash frag descriptors */
 249         ptl_hdr_t               ltx_hdr;        /* buffer for packet header */
 250 } ksock_ltx_t;
 251
 252 #define KSOCK_TX_2_KPR_FWD_DESC(ptr)    list_entry ((kprfd_scratch_t *)ptr, kpr_fwd_desc_t, kprfd_scratch)
 253 /* forwarded packets (router->socknal) embedded in kpr_fwd_desc_t::kprfd_scratch */
 254
 255 #define KSOCK_TX_2_KSOCK_LTX(ptr)       list_entry (ptr, ksock_ltx_t, ltx_tx)
 256 /* local packets (lib->socknal) embedded in ksock_ltx_t::ltx_tx */
 257
 258 /* NB list_entry() is used here as convenient macro for calculating a
 259  * pointer to a struct from the address of a member. */
 260
 261 typedef struct                                  /* Kernel portals Socket Forwarding message buffer */
 262 {                                               /* (socknal->router) */
 263         struct list_head        fmb_list;       /* queue idle */
 264         kpr_fwd_desc_t          fmb_fwd;        /* router's descriptor */
 265         int                     fmb_npages;     /* # pages allocated */
 266         ksock_fmb_pool_t       *fmb_pool;       /* owning pool */
 267         struct ksock_peer      *fmb_peer;       /* peer received from */
 268         struct page            *fmb_pages[SOCKNAL_LARGE_FWD_PAGES];
 269         struct iovec            fmb_iov[SOCKNAL_LARGE_FWD_PAGES];
 270 } ksock_fmb_t;
 271
 272 /* space for the rx frag descriptors; we either read a single contiguous
 273  * header, or PTL_MD_MAX_IOV frags of payload of either type. */
 274 typedef union {
 275         struct iovec    iov[PTL_MD_MAX_IOV];
 276         ptl_kiov_t      kiov[PTL_MD_MAX_IOV];
 277 } ksock_rxiovspace_t;
 278
 279 #define SOCKNAL_RX_HEADER       1               /* reading header */
 280 #define SOCKNAL_RX_BODY         2               /* reading body (to deliver here) */
 281 #define SOCKNAL_RX_BODY_FWD     3               /* reading body (to forward) */
 282 #define SOCKNAL_RX_SLOP         4               /* skipping body */
 283 #define SOCKNAL_RX_GET_FMB      5               /* scheduled for forwarding */
 284 #define SOCKNAL_RX_FMB_SLEEP    6               /* blocked waiting for a fwd desc */
 285
 286 typedef struct ksock_conn
 287 {
 288         struct ksock_peer  *ksnc_peer;          /* owning peer */
 289         struct ksock_route *ksnc_route;         /* owning route */
 290         struct list_head    ksnc_list;          /* stash on peer's conn list */
 291         struct socket      *ksnc_sock;          /* actual socket */
 292         void               *ksnc_saved_data_ready; /* socket's original data_ready() callback */
 293         void               *ksnc_saved_write_space; /* socket's original write_space() callback */
 294         atomic_t            ksnc_refcount;      /* # users */
 295         ksock_sched_t      *ksnc_scheduler;     /* who schedules this connection */
 296         __u32               ksnc_ipaddr;        /* peer's IP */
 297         int                 ksnc_port;          /* peer's port */
 298         int                 ksnc_closing;       /* being shut down */
 299
 300         /* READER */
 301         struct list_head    ksnc_rx_list;       /* where I enq waiting input or a forwarding descriptor */
 302         unsigned long       ksnc_rx_deadline;   /* when (in jiffies) receive times out */
 303         int                 ksnc_rx_started;    /* started receiving a message */
 304         int                 ksnc_rx_ready;      /* data ready to read */
 305         int                 ksnc_rx_scheduled;  /* being progressed */
 306         int                 ksnc_rx_state;      /* what is being read */
 307         int                 ksnc_rx_nob_left;   /* # bytes to next hdr/body  */
 308         int                 ksnc_rx_nob_wanted; /* bytes actually wanted */
 309         int                 ksnc_rx_niov;       /* # iovec frags */
 310         struct iovec       *ksnc_rx_iov;        /* the iovec frags */
 311         int                 ksnc_rx_nkiov;      /* # page frags */
 312         ptl_kiov_t         *ksnc_rx_kiov;       /* the page frags */
 313         ksock_rxiovspace_t  ksnc_rx_iov_space;  /* space for frag descriptors */
 314         void               *ksnc_cookie;        /* rx lib_finalize passthru arg */
 315         ptl_hdr_t           ksnc_hdr;           /* where I read headers into */
 316
 317         /* WRITER */
 318         struct list_head    ksnc_tx_list;       /* where I enq waiting for output space */
 319         struct list_head    ksnc_tx_queue;      /* packets waiting to be sent */
 320         unsigned long       ksnc_tx_deadline;   /* when (in jiffies) tx times out */
 321         atomic_t            ksnc_tx_nob;        /* # bytes queued */
 322         int                 ksnc_tx_ready;      /* write space */
 323         int                 ksnc_tx_scheduled;  /* being progressed */
 324 } ksock_conn_t;
 325
 326 typedef struct ksock_route
 327 {
 328         struct list_head    ksnr_list;          /* chain on peer route list */
 329         struct list_head    ksnr_connect_list;  /* chain on autoconnect list */
 330         struct ksock_peer  *ksnr_peer;          /* owning peer */
 331         atomic_t            ksnr_refcount;      /* # users */
 332         int                 ksnr_sharecount;    /* lconf usage counter */
 333         unsigned long       ksnr_timeout;       /* when (in jiffies) reconnection can happen next */
 334         unsigned int        ksnr_retry_interval; /* how long between retries */
 335         __u32               ksnr_ipaddr;        /* an IP address for this peer */
 336         int                 ksnr_port;          /* port to connect to */
 337         int                 ksnr_buffer_size;   /* size of socket buffers */
 338         unsigned int        ksnr_irq_affinity:1; /* set affinity? */
 339         unsigned int        ksnr_xchange_nids:1; /* do hello protocol? */
 340         unsigned int        ksnr_nonagel:1;     /* disable nagle? */
 341         unsigned int        ksnr_eager:1;       /* connect eagery? */
 342         unsigned int        ksnr_connecting:1;  /* autoconnect in progress? */
 343         unsigned int        ksnr_deleted:1;     /* been removed from peer? */
 344         int                 ksnr_generation;    /* connection incarnation # */
 345         ksock_conn_t       *ksnr_conn;          /* NULL/active connection */
 346 } ksock_route_t;
 347
 348 typedef struct ksock_peer
 349 {
 350         struct list_head    ksnp_list;          /* stash on global peer list */
 351         ptl_nid_t           ksnp_nid;           /* who's on the other end(s) */
 352         atomic_t            ksnp_refcount;      /* # users */
 353         int                 ksnp_closing;       /* being closed */
 354         int                 ksnp_error;         /* errno on closing last conn */
 355         struct list_head    ksnp_conns;         /* all active connections */
 356         struct list_head    ksnp_routes;        /* routes */
 357         struct list_head    ksnp_tx_queue;      /* waiting packets */
 358         unsigned long       ksnp_last_alive;    /* when (in jiffies) I was last alive */
 359 } ksock_peer_t;
 360
 361
 362 extern nal_cb_t         ksocknal_lib;
 363 extern ksock_nal_data_t ksocknal_data;
 364
 365 static inline struct list_head *
 366 ksocknal_nid2peerlist (ptl_nid_t nid)
 367 {
 368         unsigned int hash = ((unsigned int)nid) % ksocknal_data.ksnd_peer_hash_size;
 369
 370         return (&ksocknal_data.ksnd_peers [hash]);
 371 }
 372
 373 static inline int
 374 ksocknal_getconnsock (ksock_conn_t *conn)
 375 {
 376         int   rc = -ESHUTDOWN;
 377
 378         read_lock (&ksocknal_data.ksnd_global_lock);
 379         if (!conn->ksnc_closing) {
 380                 rc = 0;
 381                 get_file (conn->ksnc_sock->file);
 382         }
 383         read_unlock (&ksocknal_data.ksnd_global_lock);
 384
 385         return (rc);
 386 }
 387
 388 static inline void
 389 ksocknal_putconnsock (ksock_conn_t *conn)
 390 {
 391         fput (conn->ksnc_sock->file);
 392 }
 393
 394 extern void ksocknal_put_route (ksock_route_t *route);
 395 extern void ksocknal_put_peer (ksock_peer_t *peer);
 396 extern ksock_peer_t *ksocknal_find_peer_locked (ptl_nid_t nid);
 397 extern ksock_peer_t *ksocknal_get_peer (ptl_nid_t nid);
 398 extern int ksocknal_del_route (ptl_nid_t nid, __u32 ipaddr,
 399                                int single, int keep_conn);
 400 extern int ksocknal_create_conn (ptl_nid_t nid, ksock_route_t *route,
 401                                  struct socket *sock, int bind_irq);
 402 extern void ksocknal_close_conn_locked (ksock_conn_t *conn, int why);
 403 extern int ksocknal_close_conn_unlocked (ksock_conn_t *conn, int why);
 404 extern void ksocknal_terminate_conn (ksock_conn_t *conn);
 405 extern void ksocknal_destroy_conn (ksock_conn_t *conn);
 406 extern void ksocknal_put_conn (ksock_conn_t *conn);
 407 extern int ksocknal_close_conn (ptl_nid_t nid, __u32 ipaddr);
 408
 409 extern void ksocknal_queue_tx_locked (ksock_tx_t *tx, ksock_conn_t *conn);
 410 extern void ksocknal_tx_done (ksock_tx_t *tx, int asynch);
 411 extern void ksocknal_fwd_packet (void *arg, kpr_fwd_desc_t *fwd);
 412 extern void ksocknal_fmb_callback (void *arg, int error);
 413 extern void ksocknal_notify (void *arg, ptl_nid_t gw_nid, int alive);
 414 extern int ksocknal_thread_start (int (*fn)(void *arg), void *arg);
 415 extern int ksocknal_new_packet (ksock_conn_t *conn, int skip);
 416 extern int ksocknal_scheduler (void *arg);
 417 extern void ksocknal_data_ready(struct sock *sk, int n);
 418 extern void ksocknal_write_space(struct sock *sk);
 419 extern int ksocknal_autoconnectd (void *arg);
 420 extern int ksocknal_reaper (void *arg);
 421 extern int ksocknal_setup_sock (struct socket *sock);