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 #ifdef PROPRIETARY_ELAN
  32 # include <qsw/kernel.h>
  33 #else
  34 # include <qsnet/kernel.h>
  35 #endif
  36
  37 #undef printf                                   /* nasty QSW #define */
  38
  39 #include <linux/config.h>
  40 #include <linux/module.h>
  41
  42 #include <elan3/elanregs.h>
  43 #include <elan3/elandev.h>
  44 #include <elan3/elanvp.h>
  45 #include <elan3/elan3mmu.h>
  46 #include <elan3/elanctxt.h>
  47 #include <elan3/elandebug.h>
  48 #include <elan3/urom_addrs.h>
  49 #include <elan3/busops.h>
  50 #include <elan3/kcomm.h>
  51
  52 #include <linux/kernel.h>
  53 #include <linux/mm.h>
  54 #include <linux/string.h>
  55 #include <linux/stat.h>
  56 #include <linux/errno.h>
  57 #include <linux/locks.h>
  58 #include <linux/unistd.h>
  59 #include <net/sock.h>
  60 #include <linux/uio.h>
  61
  62 #include <asm/system.h>
  63 #include <asm/uaccess.h>
  64
  65 #include <linux/fs.h>
  66 #include <linux/file.h>
  67 #include <linux/stat.h>
  68 #include <linux/list.h>
  69 #include <asm/uaccess.h>
  70 #include <asm/segment.h>
  71
  72 #define DEBUG_SUBSYSTEM S_QSWNAL
  73
  74 #include <linux/kp30.h>
  75 #include <portals/p30.h>
  76 #include <portals/lib-p30.h>
  77
  78 #define KQSW_OPTIMIZE_GETS 1
  79
  80 #define KQSW_CHECKSUM   0
  81 #if KQSW_CHECKSUM
  82 typedef unsigned long kqsw_csum_t;
  83 #define KQSW_CSUM_SIZE  (2 * sizeof (kqsw_csum_t))
  84 #else
  85 #define KQSW_CSUM_SIZE  0
  86 #endif
  87 #define KQSW_HDR_SIZE   (sizeof (ptl_hdr_t) + KQSW_CSUM_SIZE)
  88
  89 /*
  90  *  Elan NAL
  91  */
  92 #define EP_SVC_LARGE_PORTALS_SMALL      (0x10)  /* Portals over elan port number (large payloads) */
  93 #define EP_SVC_LARGE_PORTALS_LARGE      (0x11)  /* Portals over elan port number (small payloads) */
  94 /* NB small/large message sizes are GLOBAL constants */
  95
  96 /*
  97  * Performance Tuning defines
  98  * NB no mention of PAGE_SIZE for interoperability
  99  */
 100 #define KQSW_MAXPAYLOAD                 PTL_MTU
 101 #define KQSW_SMALLPAYLOAD               ((4<<10) - KQSW_HDR_SIZE) /* small/large ep receiver breakpoint */
 102
 103 #define KQSW_TX_MAXCONTIG               (1<<10) /* largest payload that gets made contiguous on transmit */
 104
 105 #define KQSW_NTXMSGS                    8       /* # normal transmit messages */
 106 #define KQSW_NNBLK_TXMSGS               256     /* # reserved transmit messages if can't block */
 107
 108 #define KQSW_NRXMSGS_LARGE              64      /* # large receive buffers */
 109 #define KQSW_EP_ENVELOPES_LARGE         128     /* # large ep envelopes */
 110
 111 #define KQSW_NRXMSGS_SMALL              256     /* # small receive buffers */
 112 #define KQSW_EP_ENVELOPES_SMALL         2048    /* # small ep envelopes */
 113
 114 #define KQSW_RESCHED                    100     /* # busy loops that forces scheduler to yield */
 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_neiov;           /* # frags */
 140         EP_IOVEC         kqrmd_eiov[0];         /* actual frags */
 141 } kqswnal_remotemd_t;
 142
 143 typedef struct
 144 {
 145         struct list_head krx_list;              /* enqueue -> thread */
 146         EP_RCVR         *krx_eprx;              /* port to post receives to */
 147         EP_RXD          *krx_rxd;               /* receive descriptor (for repost) */
 148         E3_Addr          krx_elanaddr;          /* Elan address of buffer (contiguous in elan vm) */
 149         int              krx_npages;            /* # pages in receive buffer */
 150         int              krx_nob;               /* Number Of Bytes received into buffer */
 151         atomic_t         krx_refcount;          /* who's using me? */
 152         int              krx_rpc_completed;     /* I completed peer's RPC */
 153         kpr_fwd_desc_t   krx_fwd;               /* embedded forwarding descriptor */
 154         struct page     *krx_pages[KQSW_NRXMSGPAGES_LARGE]; /* pages allocated */
 155         struct iovec     krx_iov[KQSW_NRXMSGPAGES_LARGE]; /* iovec for forwarding */
 156 }  kqswnal_rx_t;
 157
 158 typedef struct
 159 {
 160         struct list_head  ktx_list;             /* enqueue idle/active */
 161         struct list_head  ktx_delayed_list;     /* enqueue delayedtxds */
 162         int               ktx_isnblk:1;         /* reserved descriptor? */
 163         int               ktx_state:7;          /* What I'm doing */
 164         uint32_t          ktx_basepage;         /* page offset in reserved elan tx vaddrs for mapping pages */
 165         int               ktx_npages;           /* pages reserved for mapping messages */
 166         int               ktx_nmappedpages;     /* # pages mapped for current message */
 167         int               ktx_port;             /* destination ep port */
 168         ptl_nid_t         ktx_nid;              /* destination node */
 169         void             *ktx_args[2];          /* completion passthru */
 170         E3_Addr           ktx_ebuffer;          /* elan address of ktx_buffer */
 171         char             *ktx_buffer;           /* pre-allocated contiguous buffer for hdr + small payloads */
 172         unsigned long     ktx_launchtime;       /* when (in jiffies) the transmit was launched */
 173
 174         /* debug/info fields */
 175         pid_t             ktx_launcher;         /* pid of launching process */
 176         ptl_hdr_t        *ktx_wire_hdr;         /* portals header (wire endian) */
 177
 178         int               ktx_nfrag;            /* # message frags */
 179         union {
 180                 EP_IOVEC   iov[EP_MAXFRAG];     /* msg frags (elan vaddrs) */
 181                 EP_DATAVEC datav[EP_MAXFRAG];   /* DMA frags (eolan vaddrs) */
 182         }                 ktx_frags;
 183 } kqswnal_tx_t;
 184
 185 #define KTX_IDLE        0                       /* on kqn_(nblk_)idletxds */
 186 #define KTX_SENDING     1                       /* local send */
 187 #define KTX_FORWARDING  2                       /* routing a packet */
 188 #define KTX_GETTING     3                       /* local optimised get */
 189
 190 typedef struct
 191 {
 192         char               kqn_init;            /* what's been initialised */
 193         char               kqn_shuttingdown;    /* I'm trying to shut down */
 194         atomic_t           kqn_nthreads;        /* # threads still running */
 195
 196         kqswnal_rx_t      *kqn_rxds;            /* all the receive descriptors */
 197         kqswnal_tx_t      *kqn_txds;            /* all the transmit descriptors */
 198
 199         struct list_head   kqn_idletxds;        /* transmit descriptors free to use */
 200         struct list_head   kqn_nblk_idletxds;   /* reserved free transmit descriptors */
 201         struct list_head   kqn_activetxds;      /* transmit descriptors being used */
 202         spinlock_t         kqn_idletxd_lock;    /* serialise idle txd access */
 203         wait_queue_head_t  kqn_idletxd_waitq;   /* sender blocks here waiting for idle txd */
 204         struct list_head   kqn_idletxd_fwdq;    /* forwarded packets block here waiting for idle txd */
 205
 206         spinlock_t         kqn_sched_lock;      /* serialise packet schedulers */
 207         wait_queue_head_t  kqn_sched_waitq;     /* scheduler blocks here */
 208
 209         struct list_head   kqn_readyrxds;       /* rxds full of data */
 210         struct list_head   kqn_delayedfwds;     /* delayed forwards */
 211         struct list_head   kqn_delayedtxds;     /* delayed transmits */
 212
 213         spinlock_t         kqn_statelock;       /* cb_cli/cb_sti */
 214         nal_cb_t          *kqn_cb;              /* -> kqswnal_lib */
 215         EP_DEV            *kqn_epdev;           /* elan device */
 216         EP_XMTR           *kqn_eptx;            /* elan transmitter */
 217         EP_RCVR           *kqn_eprx_small;      /* elan receiver (small messages) */
 218         EP_RCVR           *kqn_eprx_large;      /* elan receiver (large messages) */
 219         ELAN3_DMA_HANDLE  *kqn_eptxdmahandle;   /* elan reserved tx vaddrs */
 220         ELAN3_DMA_HANDLE  *kqn_eprxdmahandle;   /* elan reserved rx vaddrs */
 221         kpr_router_t       kqn_router;          /* connection to Kernel Portals Router module */
 222
 223         ptl_nid_t          kqn_nid_offset;      /* this cluster's NID offset */
 224         int                kqn_nnodes;          /* this cluster's size */
 225         int                kqn_elanid;          /* this nodes's elan ID */
 226 }  kqswnal_data_t;
 227
 228 /* kqn_init state */
 229 #define KQN_INIT_NOTHING        0               /* MUST BE ZERO so zeroed state is initialised OK */
 230 #define KQN_INIT_DATA           1
 231 #define KQN_INIT_PTL            2
 232 #define KQN_INIT_ALL            3
 233
 234 extern nal_cb_t        kqswnal_lib;
 235 extern nal_t           kqswnal_api;
 236 extern kqswnal_data_t  kqswnal_data;
 237
 238 extern int kqswnal_thread_start (int (*fn)(void *arg), void *arg);
 239 extern void kqswnal_rxhandler(EP_RXD *rxd);
 240 extern int kqswnal_scheduler (void *);
 241 extern void kqswnal_fwd_packet (void *arg, kpr_fwd_desc_t *fwd);
 242 extern void kqswnal_reply_complete (EP_RXD *rxd);
 243 extern void kqswnal_requeue_rx (kqswnal_rx_t *krx);
 244
 245 static inline ptl_nid_t
 246 kqswnal_elanid2nid (int elanid)
 247 {
 248         return (kqswnal_data.kqn_nid_offset + elanid);
 249 }
 250
 251 static inline int
 252 kqswnal_nid2elanid (ptl_nid_t nid)
 253 {
 254         /* not in this cluster? */
 255         if (nid < kqswnal_data.kqn_nid_offset ||
 256             nid >= kqswnal_data.kqn_nid_offset + kqswnal_data.kqn_nnodes)
 257                 return (-1);
 258
 259         return (nid - kqswnal_data.kqn_nid_offset);
 260 }
 261
 262 static inline int
 263 kqswnal_pages_spanned (void *base, int nob)
 264 {
 265         unsigned long first_page = ((unsigned long)base) >> PAGE_SHIFT;
 266         unsigned long last_page  = (((unsigned long)base) + (nob - 1)) >> PAGE_SHIFT;
 267
 268         LASSERT (last_page >= first_page);      /* can't wrap address space */
 269         return (last_page - first_page + 1);
 270 }
 271
 272 #if KQSW_CHECKSUM
 273 static inline kqsw_csum_t kqsw_csum (kqsw_csum_t sum, void *base, int nob)
 274 {
 275         unsigned char *ptr = (unsigned char *)base;
 276
 277         while (nob-- > 0)
 278                 sum += *ptr++;
 279
 280         return (sum);
 281 }
 282 #endif
 283
 284 #endif /* _QSWNAL_H */