4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * lnet/klnds/qswlnd/qswlnd.h
38 * Basic library routines.
44 #include <qsnet/kernel.h>
45 #undef printf /* nasty QSW #define */
46 #include <linux/module.h>
48 #include <elan/epcomms.h>
50 #include <linux/kernel.h>
52 #include <linux/string.h>
53 #include <linux/stat.h>
54 #include <linux/errno.h>
55 #include <linux/buffer_head.h> /* wait_on_buffer */
56 #include <linux/unistd.h>
58 #include <linux/uio.h>
60 #include <asm/uaccess.h>
63 #include <linux/file.h>
64 #include <linux/stat.h>
65 #include <linux/list.h>
66 #include <linux/sysctl.h>
68 #define DEBUG_SUBSYSTEM S_LND
70 #include <libcfs/libcfs.h>
71 #include <lnet/lnet.h>
72 #include <lnet/lib-lnet.h>
73 #include <lnet/lnet-sysctl.h>
76 #define KQSW_SMALLMSG (4<<10) /* small/large ep receiver breakpoint */
77 #define KQSW_RESCHED 100 /* # busy loops that forces scheduler to yield */
79 #define KQSW_CKSUM 0 /* enable checksumming (protocol incompatible) */
85 #define KQSW_TX_BUFFER_SIZE (offsetof(kqswnal_msg_t, \
86 kqm_u.immediate.kqim_payload[*kqswnal_tunables.kqn_tx_maxcontig]))
87 /* The pre-allocated tx buffer (hdr + small payload) */
89 #define KQSW_NTXMSGPAGES (btopr(KQSW_TX_BUFFER_SIZE) + 1 + btopr(LNET_MAX_PAYLOAD) + 1)
90 /* Reserve elan address space for pre-allocated and pre-mapped transmit
91 * buffer and a full payload too. Extra pages allow for page alignment */
93 #define KQSW_NRXMSGPAGES_SMALL (btopr(KQSW_SMALLMSG))
94 /* receive hdr/payload always contiguous and page aligned */
95 #define KQSW_NRXMSGBYTES_SMALL (KQSW_NRXMSGPAGES_SMALL * PAGE_SIZE)
97 #define KQSW_NRXMSGPAGES_LARGE (btopr(sizeof(lnet_msg_t) + LNET_MAX_PAYLOAD))
98 /* receive hdr/payload always contiguous and page aligned */
99 #define KQSW_NRXMSGBYTES_LARGE (KQSW_NRXMSGPAGES_LARGE * PAGE_SIZE)
100 /* biggest complete packet we can receive (or transmit) */
103 /* Remote memory descriptor */
106 __u32 kqrmd_nfrag; /* # frags */
107 EP_NMD kqrmd_frag[0]; /* actual frags */
108 } kqswnal_remotemd_t;
113 lnet_hdr_t kqim_hdr; /* LNET header */
114 char kqim_payload[0]; /* piggy-backed payload */
115 } WIRE_ATTR kqswnal_immediate_msg_t;
120 lnet_hdr_t kqrm_hdr; /* LNET header */
121 kqswnal_remotemd_t kqrm_rmd; /* peer's buffer */
122 } WIRE_ATTR kqswnal_rdma_msg_t;
126 __u32 kqm_magic; /* I'm a qswlnd message */
127 __u16 kqm_version; /* this is my version number */
128 __u16 kqm_type; /* msg type */
130 __u32 kqm_cksum; /* crc32 checksum */
131 __u32 kqm_nob; /* original msg length */
134 kqswnal_immediate_msg_t immediate;
135 kqswnal_rdma_msg_t rdma;
137 } WIRE_ATTR kqswnal_msg_t;
139 #if KQSW_CKSUM /* enable checksums ? */
140 # include <linux/crc32.h>
141 static inline __u32 kqswnal_csum(__u32 crc, unsigned char const *p, size_t len)
144 return crc32_le(crc, p, len);
147 crc = ((crc + 0x100) & ~0xff) | ((crc + *p++) & 0xff) ;
151 # define QSWLND_PROTO_VERSION 0xbeef
153 # define QSWLND_PROTO_VERSION 1
156 #define QSWLND_MSG_IMMEDIATE 0
157 #define QSWLND_MSG_RDMA 1
160 EP_STATUSBLK ep_statusblk;
172 } kqswnal_rpc_reply_t;
174 typedef struct kqswnal_rx
176 cfs_list_t krx_list; /* enqueue -> thread */
177 struct kqswnal_rx *krx_alloclist;/* stack in kqn_rxds */
178 EP_RCVR *krx_eprx; /* port to post receives to */
179 EP_RXD *krx_rxd; /* receive descriptor (for repost) */
180 EP_NMD krx_elanbuffer;/* contiguous Elan buffer */
181 int krx_npages; /* # pages in receive buffer */
182 int krx_nob; /* Number Of Bytes received into buffer */
183 int krx_rpc_reply_needed:1; /* peer waiting for EKC RPC reply */
184 int krx_state; /* what this RX is doing */
185 cfs_atomic_t krx_refcount; /* how to tell when rpc is done */
187 __u32 krx_cksum; /* checksum */
189 kqswnal_rpc_reply_t krx_rpc_reply; /* rpc reply status block */
190 lnet_kiov_t krx_kiov[KQSW_NRXMSGPAGES_LARGE];/* buffer frags */
193 #define KRX_POSTED 1 /* receiving */
194 #define KRX_PARSE 2 /* ready to be parsed */
195 #define KRX_COMPLETING 3 /* waiting to be completed */
198 typedef struct kqswnal_tx
200 cfs_list_t ktx_list; /* enqueue idle/active */
201 cfs_list_t ktx_schedlist; /* enqueue on scheduler */
202 struct kqswnal_tx *ktx_alloclist; /* stack in kqn_txds */
203 unsigned int ktx_state:7; /* What I'm doing */
204 unsigned int ktx_firsttmpfrag:1; /* ktx_frags[0] is in my ebuffer ? 0 : 1 */
205 __u32 ktx_basepage; /* page offset in reserved elan tx vaddrs for mapping pages */
206 int ktx_npages; /* pages reserved for mapping messages */
207 int ktx_nmappedpages; /* # pages mapped for current message */
208 int ktx_port; /* destination ep port */
209 lnet_nid_t ktx_nid; /* destination node */
210 void *ktx_args[3]; /* completion passthru */
211 char *ktx_buffer; /* pre-allocated contiguous buffer for hdr + small payloads */
212 cfs_time_t ktx_launchtime; /* when (in jiffies) the
213 * transmit was launched */
214 int ktx_status; /* completion status */
216 __u32 ktx_cksum; /* optimized GET payload checksum */
218 /* debug/info fields */
219 pid_t ktx_launcher; /* pid of launching process */
221 int ktx_nfrag; /* # message frags */
222 int ktx_rail; /* preferred rail */
223 EP_NMD ktx_ebuffer; /* elan mapping of ktx_buffer */
224 EP_NMD ktx_frags[EP_MAXFRAG];/* elan mapping of msg frags */
227 #define KTX_IDLE 0 /* on kqn_idletxds */
228 #define KTX_SENDING 1 /* normal send */
229 #define KTX_GETTING 2 /* sending optimised get */
230 #define KTX_PUTTING 3 /* sending optimised put */
231 #define KTX_RDMA_FETCH 4 /* handling optimised put */
232 #define KTX_RDMA_STORE 5 /* handling optimised get */
236 int *kqn_tx_maxcontig; /* maximum payload to defrag */
237 int *kqn_ntxmsgs; /* # normal tx msgs */
238 int *kqn_credits; /* # concurrent sends */
239 int *kqn_peercredits; /* # concurrent sends to 1 peer */
240 int *kqn_nrxmsgs_large; /* # 'large' rx msgs */
241 int *kqn_ep_envelopes_large; /* # 'large' rx ep envelopes */
242 int *kqn_nrxmsgs_small; /* # 'small' rx msgs */
243 int *kqn_ep_envelopes_small; /* # 'small' rx ep envelopes */
244 int *kqn_optimized_puts; /* optimized PUTs? */
245 int *kqn_optimized_gets; /* optimized GETs? */
247 int *kqn_inject_csum_error; /* # csum errors to inject */
250 #if defined(CONFIG_SYSCTL) && !CFS_SYSFS_MODULE_PARM
251 struct ctl_table_header *kqn_sysctl; /* sysctl interface */
253 } kqswnal_tunables_t;
257 char kqn_init; /* what's been initialised */
258 char kqn_shuttingdown;/* I'm trying to shut down */
259 cfs_atomic_t kqn_nthreads; /* # threads running */
260 lnet_ni_t *kqn_ni; /* _the_ instance of me */
262 kqswnal_rx_t *kqn_rxds; /* stack of all the receive descriptors */
263 kqswnal_tx_t *kqn_txds; /* stack of all the transmit descriptors */
265 cfs_list_t kqn_idletxds; /* transmit descriptors free to use */
266 cfs_list_t kqn_activetxds; /* transmit descriptors being used */
267 spinlock_t kqn_idletxd_lock; /* serialise idle txd access */
268 cfs_atomic_t kqn_pending_txs; /* # transmits being prepped */
270 spinlock_t kqn_sched_lock; /* serialise packet schedulers */
271 cfs_waitq_t kqn_sched_waitq;/* scheduler blocks here */
273 cfs_list_t kqn_readyrxds; /* rxds full of data */
274 cfs_list_t kqn_donetxds; /* completed transmits */
275 cfs_list_t kqn_delayedtxds;/* delayed transmits */
277 EP_SYS *kqn_ep; /* elan system */
278 EP_NMH *kqn_ep_tx_nmh; /* elan reserved tx vaddrs */
279 EP_NMH *kqn_ep_rx_nmh; /* elan reserved rx vaddrs */
280 EP_XMTR *kqn_eptx; /* elan transmitter */
281 EP_RCVR *kqn_eprx_small; /* elan receiver (small messages) */
282 EP_RCVR *kqn_eprx_large; /* elan receiver (large messages) */
284 int kqn_nnodes; /* this cluster's size */
285 int kqn_elanid; /* this nodes's elan ID */
287 EP_STATUSBLK kqn_rpc_success;/* preset RPC reply status blocks */
288 EP_STATUSBLK kqn_rpc_failed;
289 EP_STATUSBLK kqn_rpc_version;/* reply to future version query */
290 EP_STATUSBLK kqn_rpc_magic; /* reply to future version query */
294 #define KQN_INIT_NOTHING 0 /* MUST BE ZERO so zeroed state is initialised OK */
295 #define KQN_INIT_DATA 1
296 #define KQN_INIT_ALL 2
298 extern kqswnal_tunables_t kqswnal_tunables;
299 extern kqswnal_data_t kqswnal_data;
301 extern int kqswnal_thread_start (int (*fn)(void *arg), void *arg);
302 extern void kqswnal_rxhandler(EP_RXD *rxd);
303 extern int kqswnal_scheduler (void *);
304 extern void kqswnal_rx_done (kqswnal_rx_t *krx);
306 static inline lnet_nid_t
307 kqswnal_elanid2nid (int elanid)
309 return LNET_MKNID(LNET_NIDNET(kqswnal_data.kqn_ni->ni_nid), elanid);
313 kqswnal_nid2elanid (lnet_nid_t nid)
315 __u32 elanid = LNET_NIDADDR(nid);
317 /* not in this cluster? */
318 return (elanid >= kqswnal_data.kqn_nnodes) ? -1 : elanid;
321 static inline lnet_nid_t
322 kqswnal_rx_nid(kqswnal_rx_t *krx)
324 return (kqswnal_elanid2nid(ep_rxd_node(krx->krx_rxd)));
328 kqswnal_pages_spanned (void *base, int nob)
330 unsigned long first_page = ((unsigned long)base) >> PAGE_SHIFT;
331 unsigned long last_page = (((unsigned long)base) + (nob - 1)) >> PAGE_SHIFT;
333 LASSERT (last_page >= first_page); /* can't wrap address space */
334 return (last_page - first_page + 1);
337 static inline void kqswnal_rx_decref (kqswnal_rx_t *krx)
339 LASSERT (cfs_atomic_read (&krx->krx_refcount) > 0);
340 if (cfs_atomic_dec_and_test (&krx->krx_refcount))
341 kqswnal_rx_done(krx);
344 int kqswnal_startup (lnet_ni_t *ni);
345 void kqswnal_shutdown (lnet_ni_t *ni);
346 int kqswnal_ctl (lnet_ni_t *ni, unsigned int cmd, void *arg);
347 int kqswnal_send (lnet_ni_t *ni, void *private, lnet_msg_t *lntmsg);
348 int kqswnal_recv(lnet_ni_t *ni, void *private, lnet_msg_t *lntmsg,
349 int delayed, unsigned int niov,
350 struct iovec *iov, lnet_kiov_t *kiov,
351 unsigned int offset, unsigned int mlen, unsigned int rlen);
353 int kqswnal_tunables_init(void);
354 void kqswnal_tunables_fini(void);
356 #endif /* _QSWNAL_H */