1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2004 Cluster File Systems, Inc.
5 * Author: Eric Barton <eric@bartonsoftware.com>
7 * This file is part of Lustre, http://www.lustre.org.
9 * Lustre is free software; you can redistribute it and/or
10 * modify it under the terms of version 2 of the GNU General Public
11 * License as published by the Free Software Foundation.
13 * Lustre is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with Lustre; if not, write to the Free Software
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 # define EXPORT_SYMTAB
28 #include <linux/config.h>
29 #include <linux/module.h>
30 #include <linux/kernel.h>
32 #include <linux/string.h>
33 #include <linux/stat.h>
34 #include <linux/errno.h>
35 #include <linux/smp_lock.h>
36 #include <linux/unistd.h>
37 #include <linux/uio.h>
39 #include <asm/system.h>
40 #include <asm/uaccess.h>
43 #include <linux/init.h>
45 #include <linux/file.h>
46 #include <linux/stat.h>
47 #include <linux/list.h>
48 #include <linux/kmod.h>
49 #include <linux/sysctl.h>
54 #define DEBUG_SUBSYSTEM S_NAL
56 #include <libcfs/kp30.h>
57 #include <portals/p30.h>
58 #include <portals/lib-p30.h>
59 #include <portals/nal.h>
63 #define RANAL_MAXDEVS 2 /* max # devices RapidArray supports */
65 #define RANAL_N_CONND 4 /* # connection daemons */
67 #define RANAL_MIN_RECONNECT_INTERVAL 1 /* first failed connection retry (seconds)... */
68 #define RANAL_MAX_RECONNECT_INTERVAL 60 /* ...exponentially increasing to this */
70 #define RANAL_FMA_MAX_PREFIX 232 /* max size of FMA "Prefix" */
71 #define RANAL_FMA_MAX_DATA ((7<<10)-256) /* Max FMA MSG is 7K including prefix */
73 #define RANAL_PEER_HASH_SIZE 101 /* # peer lists */
74 #define RANAL_CONN_HASH_SIZE 101 /* # conn lists */
76 #define RANAL_NTX 64 /* # tx descs */
77 #define RANAL_NTX_NBLK 256 /* # reserved tx descs */
79 #define RANAL_FMA_CQ_SIZE 8192 /* # entries in receive CQ
80 * (overflow is a performance hit) */
82 #define RANAL_RESCHED 100 /* # scheduler loops before reschedule */
84 #define RANAL_MIN_TIMEOUT 5 /* minimum timeout interval (seconds) */
85 #define RANAL_TIMEOUT2KEEPALIVE(t) (((t)+1)/2) /* timeout -> keepalive interval */
87 /* default vals for runtime tunables */
88 #define RANAL_TIMEOUT 30 /* comms timeout (seconds) */
89 #define RANAL_LISTENER_TIMEOUT 5 /* listener timeout (seconds) */
90 #define RANAL_BACKLOG 127 /* listener's backlog */
91 #define RANAL_PORT 988 /* listener's port */
92 #define RANAL_MAX_IMMEDIATE (2<<10) /* immediate payload breakpoint */
96 int kra_timeout; /* comms timeout (seconds) */
97 int kra_listener_timeout; /* max time the listener can block */
98 int kra_backlog; /* listener's backlog */
99 int kra_port; /* listener's TCP/IP port */
100 int kra_max_immediate; /* immediate payload breakpoint */
102 struct ctl_table_header *kra_sysctl; /* sysctl interface */
107 RAP_PVOID rad_handle; /* device handle */
108 RAP_PVOID rad_fma_cqh; /* FMA completion queue handle */
109 RAP_PVOID rad_rdma_cqh; /* rdma completion queue handle */
110 int rad_id; /* device id */
111 int rad_idx; /* index in kra_devices */
112 int rad_ready; /* set by device callback */
113 struct list_head rad_connq; /* connections requiring attention */
114 struct list_head rad_zombies; /* connections to free */
115 wait_queue_head_t rad_waitq; /* scheduler waits here */
116 spinlock_t rad_lock; /* serialise */
117 void *rad_scheduler; /* scheduling thread */
122 int kra_init; /* initialisation state */
123 int kra_shutdown; /* shut down? */
124 atomic_t kra_nthreads; /* # live threads */
126 struct semaphore kra_nid_mutex; /* serialise NID/listener ops */
127 struct semaphore kra_listener_signal; /* block for listener startup/shutdown */
128 struct socket *kra_listener_sock; /* listener's socket */
129 int kra_listener_shutdown; /* ask listener to close */
131 kra_device_t kra_devices[RANAL_MAXDEVS]; /* device/ptag/cq etc */
132 int kra_ndevs; /* # devices */
134 rwlock_t kra_global_lock; /* stabilize peer/conn ops */
136 struct list_head *kra_peers; /* hash table of all my known peers */
137 int kra_peer_hash_size; /* size of kra_peers */
138 atomic_t kra_npeers; /* # peers extant */
140 struct list_head *kra_conns; /* conns hashed by cqid */
141 int kra_conn_hash_size; /* size of kra_conns */
142 __u64 kra_peerstamp; /* when I started up */
143 __u64 kra_connstamp; /* conn stamp generator */
144 int kra_next_cqid; /* cqid generator */
145 atomic_t kra_nconns; /* # connections extant */
147 long kra_new_min_timeout; /* minimum timeout on any new conn */
148 wait_queue_head_t kra_reaper_waitq; /* reaper sleeps here */
149 spinlock_t kra_reaper_lock; /* serialise */
151 struct list_head kra_connd_peers; /* peers waiting for a connection */
152 struct list_head kra_connd_acceptq; /* accepted sockets to handshake */
153 wait_queue_head_t kra_connd_waitq; /* connection daemons sleep here */
154 spinlock_t kra_connd_lock; /* serialise */
156 struct list_head kra_idle_txs; /* idle tx descriptors */
157 struct list_head kra_idle_nblk_txs; /* idle reserved tx descriptors */
158 __u64 kra_next_tx_cookie; /* RDMA completion cookie */
159 wait_queue_head_t kra_idle_tx_waitq; /* block here for tx descriptor */
160 spinlock_t kra_tx_lock; /* serialise */
163 #define RANAL_INIT_NOTHING 0
164 #define RANAL_INIT_DATA 1
165 #define RANAL_INIT_LIB 2
166 #define RANAL_INIT_ALL 3
168 typedef struct kra_acceptsock /* accepted socket queued for connd */
170 struct list_head ras_list; /* queue for attention */
171 struct socket *ras_sock; /* the accepted socket */
174 /************************************************************************
175 * Wire message structs. These are sent in sender's byte order
176 * (i.e. receiver checks magic and flips if required).
179 typedef struct kra_connreq /* connection request/response */
180 { /* (sent via socket) */
181 __u32 racr_magic; /* I'm an ranal connreq */
182 __u16 racr_version; /* this is my version number */
183 __u16 racr_devid; /* sender's device ID */
184 __u64 racr_srcnid; /* sender's NID */
185 __u64 racr_dstnid; /* who sender expects to listen */
186 __u64 racr_peerstamp; /* sender's instance stamp */
187 __u64 racr_connstamp; /* sender's connection stamp */
188 __u32 racr_timeout; /* sender's timeout */
189 RAP_RI_PARAMETERS racr_riparams; /* sender's endpoint info */
194 RAP_MEM_KEY rard_key;
195 RAP_PVOID64 rard_addr;
201 ptl_hdr_t raim_hdr; /* portals header */
202 /* Portals payload is in FMA "Message Data" */
203 } kra_immediate_msg_t;
207 ptl_hdr_t raprm_hdr; /* portals header */
208 __u64 raprm_cookie; /* opaque completion cookie */
213 __u64 rapam_src_cookie; /* reflected completion cookie */
214 __u64 rapam_dst_cookie; /* opaque completion cookie */
215 kra_rdma_desc_t rapam_desc; /* sender's sink buffer */
220 ptl_hdr_t ragm_hdr; /* portals header */
221 __u64 ragm_cookie; /* opaque completion cookie */
222 kra_rdma_desc_t ragm_desc; /* sender's sink buffer */
227 __u64 racm_cookie; /* reflected completion cookie */
228 } kra_completion_msg_t;
230 typedef struct /* NB must fit in FMA "Prefix" */
232 __u32 ram_magic; /* I'm an ranal message */
233 __u16 ram_version; /* this is my version number */
234 __u16 ram_type; /* msg type */
235 __u64 ram_srcnid; /* sender's NID */
236 __u64 ram_connstamp; /* sender's connection stamp */
238 kra_immediate_msg_t immediate;
239 kra_putreq_msg_t putreq;
240 kra_putack_msg_t putack;
242 kra_completion_msg_t completion;
244 __u32 ram_seq; /* incrementing sequence number */
247 #define RANAL_MSG_MAGIC 0x0be91b92 /* unique magic */
248 #define RANAL_MSG_VERSION 1 /* current protocol version */
250 #define RANAL_MSG_FENCE 0x80 /* fence RDMA */
252 #define RANAL_MSG_NONE 0x00 /* illegal message */
253 #define RANAL_MSG_NOOP 0x01 /* empty ram_u (keepalive) */
254 #define RANAL_MSG_IMMEDIATE 0x02 /* ram_u.immediate */
255 #define RANAL_MSG_PUT_REQ 0x03 /* ram_u.putreq (src->sink) */
256 #define RANAL_MSG_PUT_NAK 0x04 /* ram_u.completion (no PUT match: sink->src) */
257 #define RANAL_MSG_PUT_ACK 0x05 /* ram_u.putack (PUT matched: sink->src) */
258 #define RANAL_MSG_PUT_DONE 0x86 /* ram_u.completion (src->sink) */
259 #define RANAL_MSG_GET_REQ 0x07 /* ram_u.get (sink->src) */
260 #define RANAL_MSG_GET_NAK 0x08 /* ram_u.completion (no GET match: src->sink) */
261 #define RANAL_MSG_GET_DONE 0x89 /* ram_u.completion (src->sink) */
262 #define RANAL_MSG_CLOSE 0x8a /* empty ram_u */
264 /***********************************************************************/
266 typedef struct kra_tx /* message descriptor */
268 struct list_head tx_list; /* queue on idle_txs/rac_sendq/rac_waitq */
269 struct kra_conn *tx_conn; /* owning conn */
270 lib_msg_t *tx_libmsg[2]; /* lib msgs to finalize on completion */
271 unsigned long tx_qtime; /* when tx started to wait for something (jiffies) */
272 int tx_isnblk; /* I'm reserved for non-blocking sends */
273 int tx_nob; /* # bytes of payload */
274 int tx_buftype; /* payload buffer type */
275 void *tx_buffer; /* source/sink buffer */
276 int tx_phys_offset; /* first page offset (if phys) */
277 int tx_phys_npages; /* # physical pages */
278 RAP_PHYS_REGION *tx_phys; /* page descriptors */
279 RAP_MEM_KEY tx_map_key; /* mapping key */
280 RAP_RDMA_DESCRIPTOR tx_rdma_desc; /* rdma descriptor */
281 __u64 tx_cookie; /* identify this tx to peer */
282 kra_msg_t tx_msg; /* FMA message buffer */
285 #define RANAL_BUF_NONE 0 /* buffer type not set */
286 #define RANAL_BUF_IMMEDIATE 1 /* immediate data */
287 #define RANAL_BUF_PHYS_UNMAPPED 2 /* physical: not mapped yet */
288 #define RANAL_BUF_PHYS_MAPPED 3 /* physical: mapped already */
289 #define RANAL_BUF_VIRT_UNMAPPED 4 /* virtual: not mapped yet */
290 #define RANAL_BUF_VIRT_MAPPED 5 /* virtual: mapped already */
292 #define RANAL_TX_IDLE 0x00 /* on freelist */
293 #define RANAL_TX_SIMPLE 0x10 /* about to send a simple message */
294 #define RANAL_TX_PUTI_REQ 0x20 /* PUT initiator about to send PUT_REQ */
295 #define RANAL_TX_PUTI_WAIT_ACK 0x21 /* PUT initiator waiting for PUT_ACK */
296 #define RANAL_TX_PUTI_RDMA 0x22 /* PUT initiator waiting for RDMA to complete */
297 #define RANAL_TX_PUTI_DONE 0x23 /* PUT initiator about to send PUT_DONE */
298 #define RANAL_TX_PUTT_NAK 0x30 /* PUT target about to send PUT_NAK */
299 #define RANAL_TX_PUTT_ACK 0x30 /* PUT target about to send PUT_ACK */
300 #define RANAL_TX_PUTT_WAIT_DONE 0x31 /* PUT target waiting for PUT_DONE */
301 #define RANAL_TX_GETI_REQ 0x40 /* GET initiator about to send GET_REQ */
302 #define RANAL_TX_GETI_WAIT_DONE 0x41 /* GET initiator waiting for GET_DONE */
303 #define RANAL_TX_GETT_NAK 0x50 /* GET target about to send PUT_NAK */
304 #define RANAL_TX_GETT_RDMA 0x51 /* GET target waiting for RDMA to complete */
305 #define RANAL_TX_GETT_DONE 0x52 /* GET target about to send GET_DONE */
307 typedef struct kra_conn
309 struct kra_peer *rac_peer; /* owning peer */
310 struct list_head rac_list; /* stash on peer's conn list */
311 struct list_head rac_hashlist; /* stash in connection hash table */
312 struct list_head rac_schedlist; /* schedule (on rad_connq) for attention */
313 struct list_head rac_fmaq; /* txs queued for FMA */
314 struct list_head rac_rdmaq; /* txs awaiting RDMA completion */
315 struct list_head rac_replyq; /* txs awaiting replies */
316 __u64 rac_peerstamp; /* peer's unique stamp */
317 __u64 rac_peer_connstamp; /* peer's unique connection stamp */
318 __u64 rac_my_connstamp; /* my unique connection stamp */
319 unsigned long rac_last_tx; /* when I last sent an FMA message (jiffies) */
320 unsigned long rac_last_rx; /* when I last received an FMA messages (jiffies) */
321 long rac_keepalive; /* keepalive interval (seconds) */
322 long rac_timeout; /* infer peer death if no rx for this many seconds */
323 __u32 rac_cqid; /* my completion callback id (non-unique) */
324 __u32 rac_tx_seq; /* tx msg sequence number */
325 __u32 rac_rx_seq; /* rx msg sequence number */
326 atomic_t rac_refcount; /* # users */
327 unsigned int rac_close_sent; /* I've sent CLOSE */
328 unsigned int rac_close_recvd; /* I've received CLOSE */
329 unsigned int rac_state; /* connection state */
330 unsigned int rac_scheduled; /* being attented to */
331 spinlock_t rac_lock; /* serialise */
332 kra_device_t *rac_device; /* which device */
333 RAP_PVOID rac_rihandle; /* RA endpoint */
334 kra_msg_t *rac_rxmsg; /* incoming message (FMA prefix) */
335 kra_msg_t rac_msg; /* keepalive/CLOSE message buffer */
338 #define RANAL_CONN_ESTABLISHED 0
339 #define RANAL_CONN_CLOSING 1
340 #define RANAL_CONN_CLOSED 2
342 typedef struct kra_peer
344 struct list_head rap_list; /* stash on global peer list */
345 struct list_head rap_connd_list; /* schedule on kra_connd_peers */
346 struct list_head rap_conns; /* all active connections */
347 struct list_head rap_tx_queue; /* msgs waiting for a conn */
348 ptl_nid_t rap_nid; /* who's on the other end(s) */
349 __u32 rap_ip; /* IP address of peer */
350 int rap_port; /* port on which peer listens */
351 atomic_t rap_refcount; /* # users */
352 int rap_persistence; /* "known" peer refs */
353 int rap_connecting; /* connection forming */
354 unsigned long rap_reconnect_time; /* CURRENT_SECONDS when reconnect OK */
355 unsigned long rap_reconnect_interval; /* exponential backoff */
358 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,6,0))
359 # define sk_allocation allocation
360 # define sk_data_ready data_ready
361 # define sk_write_space write_space
362 # define sk_user_data user_data
363 # define sk_prot prot
364 # define sk_sndbuf sndbuf
365 # define sk_socket socket
366 # define sk_wmem_queued wmem_queued
368 # define sk_sleep sleep
371 extern lib_nal_t kranal_lib;
372 extern kra_data_t kranal_data;
373 extern kra_tunables_t kranal_tunables;
375 extern void kranal_destroy_peer(kra_peer_t *peer);
376 extern void kranal_destroy_conn(kra_conn_t *conn);
379 kranal_peer_addref(kra_peer_t *peer)
381 CDEBUG(D_NET, "%p->"LPX64"\n", peer, peer->rap_nid);
382 LASSERT(atomic_read(&peer->rap_refcount) > 0);
383 atomic_inc(&peer->rap_refcount);
387 kranal_peer_decref(kra_peer_t *peer)
389 CDEBUG(D_NET, "%p->"LPX64"\n", peer, peer->rap_nid);
390 LASSERT(atomic_read(&peer->rap_refcount) > 0);
391 if (atomic_dec_and_test(&peer->rap_refcount))
392 kranal_destroy_peer(peer);
395 static inline struct list_head *
396 kranal_nid2peerlist (ptl_nid_t nid)
398 unsigned int hash = ((unsigned int)nid) % kranal_data.kra_peer_hash_size;
400 return (&kranal_data.kra_peers[hash]);
404 kranal_peer_active(kra_peer_t *peer)
406 /* Am I in the peer hash table? */
407 return (!list_empty(&peer->rap_list));
411 kranal_conn_addref(kra_conn_t *conn)
413 CDEBUG(D_NET, "%p->"LPX64"\n", conn, conn->rac_peer->rap_nid);
414 LASSERT(atomic_read(&conn->rac_refcount) > 0);
415 atomic_inc(&conn->rac_refcount);
419 kranal_conn_decref(kra_conn_t *conn)
421 CDEBUG(D_NET, "%p->"LPX64"\n", conn, conn->rac_peer->rap_nid);
422 LASSERT(atomic_read(&conn->rac_refcount) > 0);
423 if (atomic_dec_and_test(&conn->rac_refcount))
424 kranal_destroy_conn(conn);
427 static inline struct list_head *
428 kranal_cqid2connlist (__u32 cqid)
430 unsigned int hash = cqid % kranal_data.kra_conn_hash_size;
432 return (&kranal_data.kra_conns [hash]);
435 static inline kra_conn_t *
436 kranal_cqid2conn_locked (__u32 cqid)
438 struct list_head *conns = kranal_cqid2connlist(cqid);
439 struct list_head *tmp;
442 list_for_each(tmp, conns) {
443 conn = list_entry(tmp, kra_conn_t, rac_hashlist);
445 if (conn->rac_cqid == cqid)
453 kranal_tx_mapped (kra_tx_t *tx)
455 return (tx->tx_buftype == RANAL_BUF_VIRT_MAPPED ||
456 tx->tx_buftype == RANAL_BUF_PHYS_MAPPED);
460 kranal_page2phys (struct page *p)
462 return page_to_phys(p);
465 extern void kranal_free_acceptsock (kra_acceptsock_t *ras);
466 extern int kranal_listener_procint (ctl_table *table,
467 int write, struct file *filp,
468 void *buffer, size_t *lenp);
469 extern void kranal_update_reaper_timeout (long timeout);
470 extern void kranal_tx_done (kra_tx_t *tx, int completion);
471 extern void kranal_unlink_peer_locked (kra_peer_t *peer);
472 extern void kranal_schedule_conn (kra_conn_t *conn);
473 extern kra_peer_t *kranal_create_peer (ptl_nid_t nid);
474 extern kra_peer_t *kranal_find_peer_locked (ptl_nid_t nid);
475 extern void kranal_post_fma (kra_conn_t *conn, kra_tx_t *tx);
476 extern int kranal_del_peer (ptl_nid_t nid, int single_share);
477 extern void kranal_device_callback (RAP_INT32 devid, RAP_PVOID arg);
478 extern int kranal_thread_start (int(*fn)(void *arg), void *arg);
479 extern int kranal_connd (void *arg);
480 extern int kranal_reaper (void *arg);
481 extern int kranal_scheduler (void *arg);
482 extern void kranal_close_conn_locked (kra_conn_t *conn, int error);
483 extern void kranal_terminate_conn_locked (kra_conn_t *conn);
484 extern void kranal_connect (kra_peer_t *peer);
485 extern int kranal_conn_handshake (struct socket *sock, kra_peer_t *peer);
486 extern void kranal_pause(int ticks);