lustre/portals/knals/qswnal/qswnal.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 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
  57 #include <linux/locks.h>        /* wait_on_buffer */
  58 #else
  59 #include <linux/buffer_head.h>  /* wait_on_buffer */
  60 #endif
  61 #include <linux/unistd.h>
  62 #include <net/sock.h>
  63 #include <linux/uio.h>
  64
  65 #include <asm/system.h>
  66 #include <asm/uaccess.h>
  67
  68 #include <linux/fs.h>
  69 #include <linux/file.h>
  70 #include <linux/stat.h>
  71 #include <linux/list.h>
  72 #include <linux/sysctl.h>
  73 #include <asm/segment.h>
  74
  75 #define DEBUG_SUBSYSTEM S_QSWNAL
  76
  77 #include <linux/kp30.h>
  78 #include <linux/kpr.h>
  79 #include <portals/p30.h>
  80 #include <portals/lib-p30.h>
  81 #include <portals/nal.h>
  82
  83 #define KQSW_CHECKSUM   0
  84 #if KQSW_CHECKSUM
  85 typedef unsigned long kqsw_csum_t;
  86 #define KQSW_CSUM_SIZE  (2 * sizeof (kqsw_csum_t))
  87 #else
  88 #define KQSW_CSUM_SIZE  0
  89 #endif
  90 #define KQSW_HDR_SIZE   (sizeof (ptl_hdr_t) + KQSW_CSUM_SIZE)
  91
  92 /*
  93  * Performance Tuning defines
  94  * NB no mention of PAGE_SIZE for interoperability
  95  */
  96 #define KQSW_MAXPAYLOAD                 PTL_MTU
  97 #define KQSW_SMALLPAYLOAD               ((4<<10) - KQSW_HDR_SIZE) /* small/large ep receiver breakpoint */
  98
  99 #define KQSW_TX_MAXCONTIG               (1<<10) /* largest payload that gets made contiguous on transmit */
 100
 101 #define KQSW_NTXMSGS                    8       /* # normal transmit messages */
 102 #define KQSW_NNBLK_TXMSGS               256     /* # reserved transmit messages if can't block */
 103
 104 #define KQSW_NRXMSGS_LARGE              64      /* # large receive buffers */
 105 #define KQSW_EP_ENVELOPES_LARGE         128     /* # large ep envelopes */
 106
 107 #define KQSW_NRXMSGS_SMALL              256     /* # small receive buffers */
 108 #define KQSW_EP_ENVELOPES_SMALL         2048    /* # small ep envelopes */
 109
 110 #define KQSW_RESCHED                    100     /* # busy loops that forces scheduler to yield */
 111
 112 #define KQSW_OPTIMIZED_GETS             1       /* optimize gets >= this size */
 113 #define KQSW_OPTIMIZED_PUTS            (32<<10) /* optimize puts >= this size */
 114 #define KQSW_COPY_SMALL_FWD             0       /* copy small fwd messages to pre-mapped buffer? */
 115
 116 /*
 117  * derived constants
 118  */
 119
 120 #define KQSW_TX_BUFFER_SIZE     (KQSW_HDR_SIZE + KQSW_TX_MAXCONTIG)
 121 /* The pre-allocated tx buffer (hdr + small payload) */
 122
 123 #define KQSW_NTXMSGPAGES        (btopr(KQSW_TX_BUFFER_SIZE) + 1 + btopr(KQSW_MAXPAYLOAD) + 1)
 124 /* Reserve elan address space for pre-allocated and pre-mapped transmit
 125  * buffer and a full payload too.  Extra pages allow for page alignment */
 126
 127 #define KQSW_NRXMSGPAGES_SMALL  (btopr(KQSW_HDR_SIZE + KQSW_SMALLPAYLOAD))
 128 /* receive hdr/payload always contiguous and page aligned */
 129 #define KQSW_NRXMSGBYTES_SMALL  (KQSW_NRXMSGPAGES_SMALL * PAGE_SIZE)
 130
 131 #define KQSW_NRXMSGPAGES_LARGE  (btopr(KQSW_HDR_SIZE + KQSW_MAXPAYLOAD))
 132 /* receive hdr/payload always contiguous and page aligned */
 133 #define KQSW_NRXMSGBYTES_LARGE  (KQSW_NRXMSGPAGES_LARGE * PAGE_SIZE)
 134 /* biggest complete packet we can receive (or transmit) */
 135
 136 /* Remote memory descriptor */
 137 typedef struct
 138 {
 139         __u32            kqrmd_nfrag;           /* # frags */
 140 #if MULTIRAIL_EKC
 141         EP_NMD           kqrmd_frag[0];         /* actual frags */
 142 #else
 143         EP_IOVEC         kqrmd_frag[0];         /* actual frags */
 144 #endif
 145 } kqswnal_remotemd_t;
 146
 147 typedef struct
 148 {
 149         struct list_head krx_list;              /* enqueue -> thread */
 150         EP_RCVR         *krx_eprx;              /* port to post receives to */
 151         EP_RXD          *krx_rxd;               /* receive descriptor (for repost) */
 152 #if MULTIRAIL_EKC
 153         EP_NMD           krx_elanbuffer;        /* contiguous Elan buffer */
 154 #else
 155         E3_Addr          krx_elanbuffer;        /* contiguous Elan buffer */
 156 #endif
 157         int              krx_npages;            /* # pages in receive buffer */
 158         int              krx_nob;               /* Number Of Bytes received into buffer */
 159         int              krx_rpc_reply_needed;  /* peer waiting for EKC RPC reply */
 160         int              krx_rpc_reply_status;  /* what status to send */
 161         int              krx_state;             /* what this RX is doing */
 162         atomic_t         krx_refcount;          /* how to tell when rpc is done */
 163         kpr_fwd_desc_t   krx_fwd;               /* embedded forwarding descriptor */
 164         ptl_kiov_t       krx_kiov[KQSW_NRXMSGPAGES_LARGE]; /* buffer frags */
 165 }  kqswnal_rx_t;
 166
 167 #define KRX_POSTED       1                      /* receiving */
 168 #define KRX_PARSE        2                      /* ready to be parsed */
 169 #define KRX_COMPLETING   3                      /* waiting to be completed */
 170
 171
 172 typedef struct
 173 {
 174         struct list_head  ktx_list;             /* enqueue idle/active */
 175         struct list_head  ktx_delayed_list;     /* enqueue delayedtxds */
 176         unsigned int      ktx_isnblk:1;         /* reserved descriptor? */
 177         unsigned int      ktx_state:7;          /* What I'm doing */
 178         unsigned int      ktx_firsttmpfrag:1;   /* ktx_frags[0] is in my ebuffer ? 0 : 1 */
 179         uint32_t          ktx_basepage;         /* page offset in reserved elan tx vaddrs for mapping pages */
 180         int               ktx_npages;           /* pages reserved for mapping messages */
 181         int               ktx_nmappedpages;     /* # pages mapped for current message */
 182         int               ktx_port;             /* destination ep port */
 183         ptl_nid_t         ktx_nid;              /* destination node */
 184         void             *ktx_args[3];          /* completion passthru */
 185         char             *ktx_buffer;           /* pre-allocated contiguous buffer for hdr + small payloads */
 186         unsigned long     ktx_launchtime;       /* when (in jiffies) the transmit was launched */
 187
 188         /* debug/info fields */
 189         pid_t             ktx_launcher;         /* pid of launching process */
 190
 191         int               ktx_nfrag;            /* # message frags */
 192 #if MULTIRAIL_EKC
 193         int               ktx_rail;             /* preferred rail */
 194         EP_NMD            ktx_ebuffer;          /* elan mapping of ktx_buffer */
 195         EP_NMD            ktx_frags[EP_MAXFRAG];/* elan mapping of msg frags */
 196 #else
 197         E3_Addr           ktx_ebuffer;          /* elan address of ktx_buffer */
 198         EP_IOVEC          ktx_frags[EP_MAXFRAG];/* msg frags (elan vaddrs) */
 199 #endif
 200 } kqswnal_tx_t;
 201
 202 #define KTX_IDLE        0                       /* on kqn_(nblk_)idletxds */
 203 #define KTX_FORWARDING  1                       /* sending a forwarded packet */
 204 #define KTX_SENDING     2                       /* normal send */
 205 #define KTX_GETTING     3                       /* sending optimised get */
 206 #define KTX_PUTTING     4                       /* sending optimised put */
 207 #define KTX_RDMAING     5                       /* handling optimised put/get */
 208
 209 typedef struct
 210 {
 211         /* dynamic tunables... */
 212         int                      kqn_optimized_puts;  /* optimized PUTs? */
 213         int                      kqn_optimized_gets;  /* optimized GETs? */
 214 #if CONFIG_SYSCTL
 215         struct ctl_table_header *kqn_sysctl;          /* sysctl interface */
 216 #endif
 217 } kqswnal_tunables_t;
 218
 219 typedef struct
 220 {
 221         char               kqn_init;            /* what's been initialised */
 222         char               kqn_shuttingdown;    /* I'm trying to shut down */
 223         atomic_t           kqn_nthreads;        /* # threads running */
 224
 225         kqswnal_rx_t      *kqn_rxds;            /* all the receive descriptors */
 226         kqswnal_tx_t      *kqn_txds;            /* all the transmit descriptors */
 227
 228         struct list_head   kqn_idletxds;        /* transmit descriptors free to use */
 229         struct list_head   kqn_nblk_idletxds;   /* reserved free transmit descriptors */
 230         struct list_head   kqn_activetxds;      /* transmit descriptors being used */
 231         spinlock_t         kqn_idletxd_lock;    /* serialise idle txd access */
 232         wait_queue_head_t  kqn_idletxd_waitq;   /* sender blocks here waiting for idle txd */
 233         struct list_head   kqn_idletxd_fwdq;    /* forwarded packets block here waiting for idle txd */
 234         atomic_t           kqn_pending_txs;     /* # transmits being prepped */
 235
 236         spinlock_t         kqn_sched_lock;      /* serialise packet schedulers */
 237         wait_queue_head_t  kqn_sched_waitq;     /* scheduler blocks here */
 238
 239         struct list_head   kqn_readyrxds;       /* rxds full of data */
 240         struct list_head   kqn_delayedfwds;     /* delayed forwards */
 241         struct list_head   kqn_delayedtxds;     /* delayed transmits */
 242
 243 #if MULTIRAIL_EKC
 244         EP_SYS            *kqn_ep;              /* elan system */
 245         EP_NMH            *kqn_ep_tx_nmh;       /* elan reserved tx vaddrs */
 246         EP_NMH            *kqn_ep_rx_nmh;       /* elan reserved rx vaddrs */
 247 #else
 248         EP_DEV            *kqn_ep;              /* elan device */
 249         ELAN3_DMA_HANDLE  *kqn_eptxdmahandle;   /* elan reserved tx vaddrs */
 250         ELAN3_DMA_HANDLE  *kqn_eprxdmahandle;   /* elan reserved rx vaddrs */
 251 #endif
 252         EP_XMTR           *kqn_eptx;            /* elan transmitter */
 253         EP_RCVR           *kqn_eprx_small;      /* elan receiver (small messages) */
 254         EP_RCVR           *kqn_eprx_large;      /* elan receiver (large messages) */
 255         kpr_router_t       kqn_router;          /* connection to Kernel Portals Router module */
 256
 257         ptl_nid_t          kqn_nid_offset;      /* this cluster's NID offset */
 258         int                kqn_nnodes;          /* this cluster's size */
 259         int                kqn_elanid;          /* this nodes's elan ID */
 260
 261         EP_STATUSBLK       kqn_rpc_success;     /* preset RPC reply status blocks */
 262         EP_STATUSBLK       kqn_rpc_failed;
 263 }  kqswnal_data_t;
 264
 265 /* kqn_init state */
 266 #define KQN_INIT_NOTHING        0               /* MUST BE ZERO so zeroed state is initialised OK */
 267 #define KQN_INIT_DATA           1
 268 #define KQN_INIT_LIB            2
 269 #define KQN_INIT_ALL            3
 270
 271 extern lib_nal_t           kqswnal_lib;
 272 extern nal_t               kqswnal_api;
 273 extern kqswnal_tunables_t  kqswnal_tunables;
 274 extern kqswnal_data_t      kqswnal_data;
 275
 276 extern int kqswnal_thread_start (int (*fn)(void *arg), void *arg);
 277 extern void kqswnal_rxhandler(EP_RXD *rxd);
 278 extern int kqswnal_scheduler (void *);
 279 extern void kqswnal_fwd_packet (void *arg, kpr_fwd_desc_t *fwd);
 280 extern void kqswnal_rx_done (kqswnal_rx_t *krx);
 281
 282 static inline ptl_nid_t
 283 kqswnal_elanid2nid (int elanid)
 284 {
 285         return (kqswnal_data.kqn_nid_offset + elanid);
 286 }
 287
 288 static inline int
 289 kqswnal_nid2elanid (ptl_nid_t nid)
 290 {
 291         /* not in this cluster? */
 292         if (nid < kqswnal_data.kqn_nid_offset ||
 293             nid >= kqswnal_data.kqn_nid_offset + kqswnal_data.kqn_nnodes)
 294                 return (-1);
 295
 296         return (nid - kqswnal_data.kqn_nid_offset);
 297 }
 298
 299 static inline ptl_nid_t
 300 kqswnal_rx_nid(kqswnal_rx_t *krx)
 301 {
 302         return (kqswnal_elanid2nid(ep_rxd_node(krx->krx_rxd)));
 303 }
 304
 305 static inline int
 306 kqswnal_pages_spanned (void *base, int nob)
 307 {
 308         unsigned long first_page = ((unsigned long)base) >> PAGE_SHIFT;
 309         unsigned long last_page  = (((unsigned long)base) + (nob - 1)) >> PAGE_SHIFT;
 310
 311         LASSERT (last_page >= first_page);      /* can't wrap address space */
 312         return (last_page - first_page + 1);
 313 }
 314
 315 #if KQSW_CHECKSUM
 316 static inline kqsw_csum_t kqsw_csum (kqsw_csum_t sum, void *base, int nob)
 317 {
 318         unsigned char *ptr = (unsigned char *)base;
 319
 320         while (nob-- > 0)
 321                 sum += *ptr++;
 322
 323         return (sum);
 324 }
 325 #endif
 326
 327 static inline void kqswnal_rx_decref (kqswnal_rx_t *krx)
 328 {
 329         LASSERT (atomic_read (&krx->krx_refcount) > 0);
 330         if (atomic_dec_and_test (&krx->krx_refcount))
 331                 kqswnal_rx_done(krx);
 332 }
 333
 334 #if MULTIRAIL_EKC
 335 # ifndef EP_RAILMASK_ALL
 336 #  error "old (unsupported) version of EKC headers"
 337 # endif
 338 #else
 339 /* multirail defines these in <elan/epcomms.h> */
 340 #define EP_MSG_SVC_PORTALS_SMALL      (0x10)  /* Portals over elan port number (large payloads) */
 341 #define EP_MSG_SVC_PORTALS_LARGE      (0x11)  /* Portals over elan port number (small payloads) */
 342 /* NB small/large message sizes are GLOBAL constants */
 343
 344 /* A minimal attempt to minimise inline #ifdeffing */
 345
 346 #define EP_SUCCESS      ESUCCESS
 347 #define EP_ENOMEM       ENOMEM
 348
 349 static inline EP_XMTR *
 350 ep_alloc_xmtr(EP_DEV *e)
 351 {
 352         return (ep_alloc_large_xmtr(e));
 353 }
 354
 355 static inline EP_RCVR *
 356 ep_alloc_rcvr(EP_DEV *e, int svc, int nenv)
 357 {
 358         return (ep_install_large_rcvr(e, svc, nenv));
 359 }
 360
 361 static inline void
 362 ep_free_xmtr(EP_XMTR *x)
 363 {
 364         ep_free_large_xmtr(x);
 365 }
 366
 367 static inline void
 368 ep_free_rcvr(EP_RCVR *r)
 369 {
 370         ep_remove_large_rcvr(r);
 371 }
 372 #endif
 373
 374 #endif /* _QSWNAL_H */