lnet/klnds/qswlnd/qswlnd.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  *  Copyright (C) 2001 Cluster File Systems, Inc. <braam@clusterfs.com>
   5  *
   6  *   This file is part of Lustre, http://www.lustre.org.
   7  *
   8  *   Lustre is free software; you can redistribute it and/or
   9  *   modify it under the terms of version 2 of the GNU General Public
  10  *   License as published by the Free Software Foundation.
  11  *
  12  *   Lustre is distributed in the hope that it will be useful,
  13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *   GNU General Public License for more details.
  16  *
  17  *   You should have received a copy of the GNU General Public License
  18  *   along with Lustre; if not, write to the Free Software
  19  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  * Basic library routines.
  22  *
  23  */
  24
  25 #ifndef _QSWNAL_H
  26 #define _QSWNAL_H
  27 #ifndef EXPORT_SYMTAB
  28 # define EXPORT_SYMTAB
  29 #endif
  30
  31 #include <qsnet/kernel.h>
  32 #undef printf                                   /* nasty QSW #define */
  33
  34 #include <linux/config.h>
  35 #include <linux/module.h>
  36
  37 #if MULTIRAIL_EKC
  38 # include <elan/epcomms.h>
  39 #else
  40 # include <elan3/elanregs.h>
  41 # include <elan3/elandev.h>
  42 # include <elan3/elanvp.h>
  43 # include <elan3/elan3mmu.h>
  44 # include <elan3/elanctxt.h>
  45 # include <elan3/elandebug.h>
  46 # include <elan3/urom_addrs.h>
  47 # include <elan3/busops.h>
  48 # include <elan3/kcomm.h>
  49 #endif
  50
  51 #include <linux/kernel.h>
  52 #include <linux/mm.h>
  53 #include <linux/string.h>
  54 #include <linux/stat.h>
  55 #include <linux/errno.h>
  56 #include <linux/locks.h>
  57 #include <linux/unistd.h>
  58 #include <net/sock.h>
  59 #include <linux/uio.h>
  60
  61 #include <asm/system.h>
  62 #include <asm/uaccess.h>
  63
  64 #include <linux/fs.h>
  65 #include <linux/file.h>
  66 #include <linux/stat.h>
  67 #include <linux/list.h>
  68 #include <linux/sysctl.h>
  69 #include <asm/segment.h>
  70
  71 #define DEBUG_SUBSYSTEM S_QSWNAL
  72
  73 #include <linux/kp30.h>
  74 #include <linux/kpr.h>
  75 #include <portals/p30.h>
  76 #include <portals/lib-p30.h>
  77
  78 #define KQSW_CHECKSUM   0
  79 #if KQSW_CHECKSUM
  80 typedef unsigned long kqsw_csum_t;
  81 #define KQSW_CSUM_SIZE  (2 * sizeof (kqsw_csum_t))
  82 #else
  83 #define KQSW_CSUM_SIZE  0
  84 #endif
  85 #define KQSW_HDR_SIZE   (sizeof (ptl_hdr_t) + KQSW_CSUM_SIZE)
  86
  87 /*
  88  * Performance Tuning defines
  89  * NB no mention of PAGE_SIZE for interoperability
  90  */
  91 #define KQSW_MAXPAYLOAD                 PTL_MTU
  92 #define KQSW_SMALLPAYLOAD               ((4<<10) - KQSW_HDR_SIZE) /* small/large ep receiver breakpoint */
  93
  94 #define KQSW_TX_MAXCONTIG               (1<<10) /* largest payload that gets made contiguous on transmit */
  95
  96 #define KQSW_NTXMSGS                    8       /* # normal transmit messages */
  97 #define KQSW_NNBLK_TXMSGS               256     /* # reserved transmit messages if can't block */
  98
  99 #define KQSW_NRXMSGS_LARGE              64      /* # large receive buffers */
 100 #define KQSW_EP_ENVELOPES_LARGE         128     /* # large ep envelopes */
 101
 102 #define KQSW_NRXMSGS_SMALL              256     /* # small receive buffers */
 103 #define KQSW_EP_ENVELOPES_SMALL         2048    /* # small ep envelopes */
 104
 105 #define KQSW_RESCHED                    100     /* # busy loops that forces scheduler to yield */
 106
 107 #define KQSW_OPTIMIZED_GETS             1       /* optimized gets? */
 108 #define KQSW_COPY_SMALL_FWD             0       /* copy small fwd messages to pre-mapped buffer? */
 109
 110 /*
 111  * derived constants
 112  */
 113
 114 #define KQSW_TX_BUFFER_SIZE     (KQSW_HDR_SIZE + KQSW_TX_MAXCONTIG)
 115 /* The pre-allocated tx buffer (hdr + small payload) */
 116
 117 #define KQSW_NTXMSGPAGES        (btopr(KQSW_TX_BUFFER_SIZE) + 1 + btopr(KQSW_MAXPAYLOAD) + 1)
 118 /* Reserve elan address space for pre-allocated and pre-mapped transmit
 119  * buffer and a full payload too.  Extra pages allow for page alignment */
 120
 121 #define KQSW_NRXMSGPAGES_SMALL  (btopr(KQSW_HDR_SIZE + KQSW_SMALLPAYLOAD))
 122 /* receive hdr/payload always contiguous and page aligned */
 123 #define KQSW_NRXMSGBYTES_SMALL  (KQSW_NRXMSGPAGES_SMALL * PAGE_SIZE)
 124
 125 #define KQSW_NRXMSGPAGES_LARGE  (btopr(KQSW_HDR_SIZE + KQSW_MAXPAYLOAD))
 126 /* receive hdr/payload always contiguous and page aligned */
 127 #define KQSW_NRXMSGBYTES_LARGE  (KQSW_NRXMSGPAGES_LARGE * PAGE_SIZE)
 128 /* biggest complete packet we can receive (or transmit) */
 129
 130 /* Remote memory descriptor */
 131 typedef struct
 132 {
 133         __u32            kqrmd_nfrag;           /* # frags */
 134 #if MULTIRAIL_EKC
 135         EP_NMD           kqrmd_frag[0];         /* actual frags */
 136 #else
 137         EP_IOVEC         kqrmd_frag[0];         /* actual frags */
 138 #endif
 139 } kqswnal_remotemd_t;
 140
 141 typedef struct
 142 {
 143         struct list_head krx_list;              /* enqueue -> thread */
 144         EP_RCVR         *krx_eprx;              /* port to post receives to */
 145         EP_RXD          *krx_rxd;               /* receive descriptor (for repost) */
 146 #if MULTIRAIL_EKC
 147         EP_NMD           krx_elanbuffer;        /* contiguous Elan buffer */
 148 #else
 149         E3_Addr          krx_elanbuffer;        /* contiguous Elan buffer */
 150 #endif
 151         int              krx_npages;            /* # pages in receive buffer */
 152         int              krx_nob;               /* Number Of Bytes received into buffer */
 153         int              krx_rpc_reply_needed;  /* peer waiting for EKC RPC reply */
 154         int              krx_rpc_reply_sent;    /* rpc reply sent */
 155         atomic_t         krx_refcount;          /* how to tell when rpc is done */
 156         kpr_fwd_desc_t   krx_fwd;               /* embedded forwarding descriptor */
 157         ptl_kiov_t       krx_kiov[KQSW_NRXMSGPAGES_LARGE]; /* buffer frags */
 158 }  kqswnal_rx_t;
 159
 160 typedef struct
 161 {
 162         struct list_head  ktx_list;             /* enqueue idle/active */
 163         struct list_head  ktx_delayed_list;     /* enqueue delayedtxds */
 164         unsigned int      ktx_isnblk:1;         /* reserved descriptor? */
 165         unsigned int      ktx_state:7;          /* What I'm doing */
 166         unsigned int      ktx_firsttmpfrag:1;   /* ktx_frags[0] is in my ebuffer ? 0 : 1 */
 167         uint32_t          ktx_basepage;         /* page offset in reserved elan tx vaddrs for mapping pages */
 168         int               ktx_npages;           /* pages reserved for mapping messages */
 169         int               ktx_nmappedpages;     /* # pages mapped for current message */
 170         int               ktx_port;             /* destination ep port */
 171         ptl_nid_t         ktx_nid;              /* destination node */
 172         void             *ktx_args[2];          /* completion passthru */
 173         char             *ktx_buffer;           /* pre-allocated contiguous buffer for hdr + small payloads */
 174         unsigned long     ktx_launchtime;       /* when (in jiffies) the transmit was launched */
 175
 176         /* debug/info fields */
 177         pid_t             ktx_launcher;         /* pid of launching process */
 178         ptl_hdr_t        *ktx_wire_hdr;         /* portals header (wire endian) */
 179
 180         int               ktx_nfrag;            /* # message frags */
 181 #if MULTIRAIL_EKC
 182         EP_NMD            ktx_ebuffer;          /* elan mapping of ktx_buffer */
 183         EP_NMD            ktx_frags[EP_MAXFRAG];/* elan mapping of msg frags */
 184 #else
 185         E3_Addr           ktx_ebuffer;          /* elan address of ktx_buffer */
 186         EP_IOVEC          ktx_frags[EP_MAXFRAG];/* msg frags (elan vaddrs) */
 187 #endif
 188 } kqswnal_tx_t;
 189
 190 #define KTX_IDLE        0                       /* on kqn_(nblk_)idletxds */
 191 #define KTX_SENDING     1                       /* local send */
 192 #define KTX_FORWARDING  2                       /* routing a packet */
 193 #define KTX_GETTING     3                       /* local optimised get */
 194
 195 typedef struct
 196 {
 197         char               kqn_init;            /* what's been initialised */
 198         char               kqn_shuttingdown;    /* I'm trying to shut down */
 199         atomic_t           kqn_nthreads;        /* # threads not terminated */
 200         atomic_t           kqn_nthreads_running;/* # threads still running */
 201
 202         int                kqn_optimized_gets;  /* optimized GETs? */
 203         int                kqn_copy_small_fwd;  /* fwd small msgs from pre-allocated buffer? */
 204
 205 #if CONFIG_SYSCTL
 206         struct ctl_table_header *kqn_sysctl;    /* sysctl interface */
 207 #endif
 208         kqswnal_rx_t      *kqn_rxds;            /* all the receive descriptors */
 209         kqswnal_tx_t      *kqn_txds;            /* all the transmit descriptors */
 210
 211         struct list_head   kqn_idletxds;        /* transmit descriptors free to use */
 212         struct list_head   kqn_nblk_idletxds;   /* reserved free transmit descriptors */
 213         struct list_head   kqn_activetxds;      /* transmit descriptors being used */
 214         spinlock_t         kqn_idletxd_lock;    /* serialise idle txd access */
 215         wait_queue_head_t  kqn_idletxd_waitq;   /* sender blocks here waiting for idle txd */
 216         struct list_head   kqn_idletxd_fwdq;    /* forwarded packets block here waiting for idle txd */
 217
 218         spinlock_t         kqn_sched_lock;      /* serialise packet schedulers */
 219         wait_queue_head_t  kqn_sched_waitq;     /* scheduler blocks here */
 220
 221         struct list_head   kqn_readyrxds;       /* rxds full of data */
 222         struct list_head   kqn_delayedfwds;     /* delayed forwards */
 223         struct list_head   kqn_delayedtxds;     /* delayed transmits */
 224
 225         spinlock_t         kqn_statelock;       /* cb_cli/cb_sti */
 226         wait_queue_head_t  kqn_yield_waitq;     /* where yield waits */
 227         nal_cb_t          *kqn_cb;              /* -> kqswnal_lib */
 228 #if MULTIRAIL_EKC
 229         EP_SYS            *kqn_ep;              /* elan system */
 230         EP_NMH            *kqn_ep_tx_nmh;       /* elan reserved tx vaddrs */
 231         EP_NMH            *kqn_ep_rx_nmh;       /* elan reserved rx vaddrs */
 232 #else
 233         EP_DEV            *kqn_ep;              /* elan device */
 234         ELAN3_DMA_HANDLE  *kqn_eptxdmahandle;   /* elan reserved tx vaddrs */
 235         ELAN3_DMA_HANDLE  *kqn_eprxdmahandle;   /* elan reserved rx vaddrs */
 236 #endif
 237         EP_XMTR           *kqn_eptx;            /* elan transmitter */
 238         EP_RCVR           *kqn_eprx_small;      /* elan receiver (small messages) */
 239         EP_RCVR           *kqn_eprx_large;      /* elan receiver (large messages) */
 240         kpr_router_t       kqn_router;          /* connection to Kernel Portals Router module */
 241
 242         ptl_nid_t          kqn_nid_offset;      /* this cluster's NID offset */
 243         int                kqn_nnodes;          /* this cluster's size */
 244         int                kqn_elanid;          /* this nodes's elan ID */
 245 }  kqswnal_data_t;
 246
 247 /* kqn_init state */
 248 #define KQN_INIT_NOTHING        0               /* MUST BE ZERO so zeroed state is initialised OK */
 249 #define KQN_INIT_DATA           1
 250 #define KQN_INIT_PTL            2
 251 #define KQN_INIT_ALL            3
 252
 253 extern nal_cb_t        kqswnal_lib;
 254 extern nal_t           kqswnal_api;
 255 extern kqswnal_data_t  kqswnal_data;
 256
 257 /* global pre-prepared replies to keep off the stack */
 258 extern EP_STATUSBLK    kqswnal_rpc_success;
 259 extern EP_STATUSBLK    kqswnal_rpc_failed;
 260
 261 extern int kqswnal_thread_start (int (*fn)(void *arg), void *arg);
 262 extern void kqswnal_rxhandler(EP_RXD *rxd);
 263 extern int kqswnal_scheduler (void *);
 264 extern void kqswnal_fwd_packet (void *arg, kpr_fwd_desc_t *fwd);
 265 extern void kqswnal_dma_reply_complete (EP_RXD *rxd);
 266 extern void kqswnal_requeue_rx (kqswnal_rx_t *krx);
 267
 268 static inline ptl_nid_t
 269 kqswnal_elanid2nid (int elanid)
 270 {
 271         return (kqswnal_data.kqn_nid_offset + elanid);
 272 }
 273
 274 static inline int
 275 kqswnal_nid2elanid (ptl_nid_t nid)
 276 {
 277         /* not in this cluster? */
 278         if (nid < kqswnal_data.kqn_nid_offset ||
 279             nid >= kqswnal_data.kqn_nid_offset + kqswnal_data.kqn_nnodes)
 280                 return (-1);
 281
 282         return (nid - kqswnal_data.kqn_nid_offset);
 283 }
 284
 285 static inline int
 286 kqswnal_pages_spanned (void *base, int nob)
 287 {
 288         unsigned long first_page = ((unsigned long)base) >> PAGE_SHIFT;
 289         unsigned long last_page  = (((unsigned long)base) + (nob - 1)) >> PAGE_SHIFT;
 290
 291         LASSERT (last_page >= first_page);      /* can't wrap address space */
 292         return (last_page - first_page + 1);
 293 }
 294
 295 #if KQSW_CHECKSUM
 296 static inline kqsw_csum_t kqsw_csum (kqsw_csum_t sum, void *base, int nob)
 297 {
 298         unsigned char *ptr = (unsigned char *)base;
 299
 300         while (nob-- > 0)
 301                 sum += *ptr++;
 302
 303         return (sum);
 304 }
 305 #endif
 306
 307 static inline void kqswnal_rx_done (kqswnal_rx_t *krx)
 308 {
 309         LASSERT (atomic_read (&krx->krx_refcount) > 0);
 310         if (atomic_dec_and_test (&krx->krx_refcount))
 311                 kqswnal_requeue_rx(krx);
 312 }
 313
 314 #if MULTIRAIL_EKC
 315 # ifndef EP_RAILMASK_ALL
 316 #  error "old (unsupported) version of EKC headers"
 317 # endif
 318 #else
 319 /* multirail defines these in <elan/epcomms.h> */
 320 #define EP_MSG_SVC_PORTALS_SMALL      (0x10)  /* Portals over elan port number (large payloads) */
 321 #define EP_MSG_SVC_PORTALS_LARGE      (0x11)  /* Portals over elan port number (small payloads) */
 322 /* NB small/large message sizes are GLOBAL constants */
 323
 324 /* A minimal attempt to minimise inline #ifdeffing */
 325
 326 #define EP_SUCCESS      ESUCCESS
 327 #define EP_ENOMEM       ENOMEM
 328
 329 static inline EP_XMTR *
 330 ep_alloc_xmtr(EP_DEV *e)
 331 {
 332         return (ep_alloc_large_xmtr(e));
 333 }
 334
 335 static inline EP_RCVR *
 336 ep_alloc_rcvr(EP_DEV *e, int svc, int nenv)
 337 {
 338         return (ep_install_large_rcvr(e, svc, nenv));
 339 }
 340
 341 static inline void
 342 ep_free_xmtr(EP_XMTR *x)
 343 {
 344         ep_free_large_xmtr(x);
 345 }
 346
 347 static inline void
 348 ep_free_rcvr(EP_RCVR *r)
 349 {
 350         ep_remove_large_rcvr(r);
 351 }
 352 #endif
 353
 354 #endif /* _QSWNAL_H */