1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2005 Cluster File Systems, Inc. All rights reserved.
5 * Author: PJ Kirner <pjkirner@clusterfs.com>
7 * This file is part of the Lustre file system, http://www.lustre.org
8 * Lustre is a trademark of Cluster File Systems, Inc.
10 * This file is confidential source code owned by Cluster File Systems.
11 * No viewing, modification, compilation, redistribution, or any other
12 * form of use is permitted except through a signed license agreement.
14 * If you have not signed such an agreement, then you have no rights to
15 * this file. Please destroy it immediately and contact CFS.
20 # define EXPORT_SYMTAB
23 #include <linux/config.h>
24 #include <linux/module.h>
25 #include <linux/kernel.h>
27 #include <linux/string.h>
28 #include <linux/stat.h>
29 #include <linux/errno.h>
30 #include <linux/smp_lock.h>
31 #include <linux/unistd.h>
32 #include <linux/uio.h>
34 #include <asm/system.h>
35 #include <asm/uaccess.h>
38 #include <linux/init.h>
40 #include <linux/file.h>
41 #include <linux/stat.h>
42 #include <linux/list.h>
43 #include <linux/kmod.h>
44 #include <linux/sysctl.h>
45 #include <linux/random.h>
51 #define DEBUG_SUBSYSTEM S_LND
53 #include <libcfs/kp30.h>
54 #include <lnet/lnet.h>
55 #include <lnet/lib-lnet.h>
56 #include <portals/p30.h>
58 #include <portals/ptltrace.h>
60 #include <lnet/ptllnd.h> /* Depends on portals/p30.h */
63 * Define this to enable console debug logging
66 //#define PJK_DEBUGGING
69 # define PTLLND_N_SCHED num_online_cpus() /* # schedulers */
71 # define PTLLND_N_SCHED 1 /* # schedulers */
74 #define PTLLND_CREDIT_HIGHWATER ((*kptllnd_tunables.kptl_peercredits)-1)
75 /* when eagerly to return credits */
79 int *kptl_ntx; /* # tx descs to pre-allocate */
80 int *kptl_max_nodes; /* max # nodes all talking to me */
81 int *kptl_max_procs_per_node; /* max # processes per node */
82 int *kptl_checksum; /* checksum kptl_msg_t? */
83 int *kptl_timeout; /* comms timeout (seconds) */
84 int *kptl_portal; /* portal number */
85 int *kptl_pid; /* portals PID (self + kernel peers) */
86 int *kptl_rxb_npages; /* number of pages for rx buffer */
87 int *kptl_rxb_nspare; /* number of spare rx buffers */
88 int *kptl_credits; /* number of credits */
89 int *kptl_peercredits; /* number of credits */
90 int *kptl_max_msg_size; /* max immd message size*/
91 int *kptl_peer_hash_table_size; /* # slots in peer hash table */
92 int *kptl_reschedule_loops; /* scheduler yield loops */
94 int *kptl_ptltrace_on_timeout; /* dump pltrace on timeout? */
95 char **kptl_ptltrace_basename; /* ptltrace dump file basename */
98 int *kptl_simulation_bitmap;/* simulation bitmap */
101 #if CONFIG_SYSCTL && !CFS_SYSFS_MODULE_PARM
102 struct ctl_table_header *kptl_sysctl; /* sysctl interface */
106 #include "lnet/ptllnd_wire.h"
108 /***********************************************************************/
110 typedef struct kptl_data kptl_data_t;
111 typedef struct kptl_rx_buffer kptl_rx_buffer_t;
112 typedef struct kptl_peer kptl_peer_t;
118 #define PTLLND_EVENTARG_TYPE_MSG 0x1
119 #define PTLLND_EVENTARG_TYPE_RDMA 0x2
120 #define PTLLND_EVENTARG_TYPE_BUF 0x3
122 typedef struct kptl_rx /* receive message */
124 struct list_head rx_list; /* queue for attention */
125 kptl_rx_buffer_t *rx_rxb; /* the rx buffer pointer */
126 kptl_msg_t *rx_msg; /* received message */
127 int rx_nob; /* received message size */
128 ptl_process_id_t rx_initiator; /* sender's address */
130 ptl_uid_t rx_uid; /* sender's uid */
132 kptl_peer_t *rx_peer; /* pointer to peer */
133 char rx_space[0]; /* copy of incoming request */
136 typedef struct kptl_rx_buffer_pool
138 spinlock_t rxbp_lock;
139 struct list_head rxbp_list; /* all allocated buffers */
140 int rxbp_count; /* # allocated buffers */
141 int rxbp_reserved; /* # requests to buffer */
142 int rxbp_shutdown; /* shutdown flag */
143 } kptl_rx_buffer_pool_t;
145 struct kptl_rx_buffer
147 kptl_rx_buffer_pool_t *rxb_pool;
148 struct list_head rxb_list; /* for the rxb_pool list */
149 struct list_head rxb_repost_list;/* for the kptl_sched_rxbq list */
150 int rxb_posted:1; /* on the net */
151 int rxb_idle:1; /* all done */
152 kptl_eventarg_t rxb_eventarg; /* event->md.user_ptr */
153 int rxb_refcount; /* reference count */
154 ptl_handle_md_t rxb_mdh; /* the portals memory descriptor (MD) handle */
155 char *rxb_buffer; /* the buffer */
161 TX_TYPE_RESERVED = 0,
162 TX_TYPE_SMALL_MESSAGE = 1,
163 TX_TYPE_PUT_REQUEST = 2,
164 TX_TYPE_GET_REQUEST = 3,
165 TX_TYPE_PUT_RESPONSE = 4,
166 TX_TYPE_GET_RESPONSE = 5,
170 #ifdef _USING_LUSTRE_PORTALS_
171 struct iovec iov[PTL_MD_MAX_IOV];
172 lnet_kiov_t kiov[PTL_MD_MAX_IOV];
174 ptl_md_iovec_t iov[PTL_MD_MAX_IOV];
178 typedef struct kptl_tx /* transmit message */
180 struct list_head tx_list; /* queue on idle_txs etc */
181 atomic_t tx_refcount; /* reference count*/
182 enum kptl_tx_type tx_type; /* small msg/{put,get}{req,resp} */
183 int tx_active:1; /* queued on the peer */
184 int tx_idle:1; /* on the free list */
185 kptl_eventarg_t tx_msg_eventarg; /* event->md.user_ptr */
186 kptl_eventarg_t tx_rdma_eventarg; /* event->md.user_ptr */
187 int tx_status; /* the status of this tx descriptor */
188 ptl_handle_md_t tx_rdma_mdh; /* RDMA buffer */
189 ptl_handle_md_t tx_msg_mdh; /* the portals MD handle for the initial message */
190 lnet_msg_t *tx_lnet_msg; /* LNET message to finalize */
191 lnet_msg_t *tx_lnet_replymsg; /* LNET reply message to finalize */
192 kptl_msg_t *tx_msg; /* the message data */
193 kptl_peer_t *tx_peer; /* the peer this is waiting on */
194 unsigned long tx_deadline; /* deadline */
195 ptl_md_t tx_rdma_md; /* rdma buffer */
196 kptl_fragvec_t *tx_rdma_frags; /* buffer fragments */
199 enum kptllnd_peer_state
201 PEER_STATE_UNINITIALIZED = 0,
202 PEER_STATE_ALLOCATED = 1,
203 PEER_STATE_WAITING_HELLO = 2,
204 PEER_STATE_ACTIVE = 3,
205 PEER_STATE_CLOSING = 4,
206 PEER_STATE_ZOMBIE = 5,
211 struct list_head peer_list;
212 atomic_t peer_refcount; /* The current refrences */
213 enum kptllnd_peer_state peer_state;
214 spinlock_t peer_lock; /* serialize */
215 struct list_head peer_sendq; /* txs waiting for mh handles */
216 struct list_head peer_activeq; /* txs awaiting completion */
217 lnet_process_id_t peer_id; /* Peer's LNET id */
218 ptl_process_id_t peer_ptlid; /* Peer's portals id */
219 __u64 peer_incarnation; /* peer's incarnation */
220 int peer_sent_hello; /* have I sent HELLO? */
221 int peer_credits; /* number of send credits */
222 int peer_outstanding_credits;/* number of peer credits */
223 int peer_error; /* errno on closing this peer */
224 cfs_time_t peer_last_alive; /* when (in jiffies) I was last alive */
225 __u64 peer_next_matchbits; /* Next value to register RDMA from peer */
226 __u64 peer_last_matchbits_seen; /* last matchbits used to RDMA to peer */
231 int kptl_init; /* initialisation state */
232 volatile int kptl_shutdown; /* shut down? */
233 atomic_t kptl_nthreads; /* # live threads */
234 lnet_ni_t *kptl_ni; /* _the_ LND instance */
235 ptl_handle_ni_t kptl_nih; /* network inteface handle */
236 ptl_process_id_t kptl_portals_id; /* Portals ID of interface */
237 __u64 kptl_incarnation; /* which one am I */
238 ptl_handle_eq_t kptl_eqh; /* Event Queue (EQ) */
240 spinlock_t kptl_sched_lock; /* serialise... */
241 wait_queue_head_t kptl_sched_waitq; /* schedulers sleep here */
242 struct list_head kptl_sched_txq; /* tx requiring attention */
243 struct list_head kptl_sched_rxq; /* rx requiring attention */
244 struct list_head kptl_sched_rxbq; /* rxb requiring reposting */
246 wait_queue_head_t kptl_watchdog_waitq; /* watchdog sleeps here */
248 kptl_rx_buffer_pool_t kptl_rx_buffer_pool; /* rx buffer pool */
249 cfs_mem_cache_t* kptl_rx_cache; /* rx descripter cache */
251 atomic_t kptl_ntx; /* # tx descs allocated */
252 spinlock_t kptl_tx_lock; /* serialise idle tx list*/
253 struct list_head kptl_idle_txs; /* idle tx descriptors */
255 rwlock_t kptl_peer_rw_lock; /* lock for peer table */
256 struct list_head *kptl_peers; /* hash table of all my known peers */
257 struct list_head kptl_closing_peers; /* peers being closed */
258 struct list_head kptl_zombie_peers; /* peers waiting for refs to drain */
259 int kptl_peer_hash_size; /* size of kptl_peers */
260 int kptl_npeers; /* # peers extant */
261 int kptl_n_active_peers; /* # active peers */
262 int kptl_expected_peers; /* # peers I can buffer HELLOs from */
264 kptl_msg_t *kptl_nak_msg; /* common NAK message */
265 spinlock_t kptl_ptlid2str_lock; /* serialise str ops */
270 PTLLND_INIT_NOTHING = 0,
275 extern kptl_tunables_t kptllnd_tunables;
276 extern kptl_data_t kptllnd_data;
278 static inline lnet_nid_t
279 kptllnd_ptl2lnetnid(ptl_nid_t ptl_nid)
281 #ifdef _USING_LUSTRE_PORTALS_
282 return LNET_MKNID(LNET_NIDNET(kptllnd_data.kptl_ni->ni_nid),
283 LNET_NIDADDR(ptl_nid));
285 return LNET_MKNID(LNET_NIDNET(kptllnd_data.kptl_ni->ni_nid),
290 static inline ptl_nid_t
291 kptllnd_lnet2ptlnid(lnet_nid_t lnet_nid)
293 #ifdef _USING_LUSTRE_PORTALS_
294 return LNET_MKNID(LNET_NIDNET(kptllnd_data.kptl_portals_id.nid),
295 LNET_NIDADDR(lnet_nid));
297 return LNET_NIDADDR(lnet_nid);
301 int kptllnd_startup(lnet_ni_t *ni);
302 void kptllnd_shutdown(lnet_ni_t *ni);
303 int kptllnd_ctl(lnet_ni_t *ni, unsigned int cmd, void *arg);
304 int kptllnd_send(lnet_ni_t *ni, void *private, lnet_msg_t *lntmsg);
305 int kptllnd_recv(lnet_ni_t *ni, void *private, lnet_msg_t *lntmsg,
306 int delayed, unsigned int niov,
307 struct iovec *iov, lnet_kiov_t *kiov,
308 unsigned int offset, unsigned int mlen, unsigned int rlen);
309 int kptllnd_eager_recv(struct lnet_ni *ni, void *private,
310 lnet_msg_t *msg, void **new_privatep);
311 void kptllnd_eq_callback(ptl_event_t *evp);
312 int kptllnd_scheduler(void *arg);
313 int kptllnd_watchdog(void *arg);
314 int kptllnd_thread_start(int (*fn)(void *arg), void *arg);
315 int kptllnd_tunables_init(void);
316 void kptllnd_tunables_fini(void);
318 const char *kptllnd_evtype2str(int evtype);
319 const char *kptllnd_msgtype2str(int msgtype);
322 kptllnd_eventarg2obj (kptl_eventarg_t *eva)
324 switch (eva->eva_type) {
327 case PTLLND_EVENTARG_TYPE_BUF:
328 return list_entry(eva, kptl_rx_buffer_t, rxb_eventarg);
329 case PTLLND_EVENTARG_TYPE_RDMA:
330 return list_entry(eva, kptl_tx_t, tx_rdma_eventarg);
331 case PTLLND_EVENTARG_TYPE_MSG:
332 return list_entry(eva, kptl_tx_t, tx_msg_eventarg);
337 * RX BUFFER SUPPORT FUNCTIONS
339 void kptllnd_rx_buffer_pool_init(kptl_rx_buffer_pool_t *rxbp);
340 void kptllnd_rx_buffer_pool_fini(kptl_rx_buffer_pool_t *rxbp);
341 int kptllnd_rx_buffer_pool_reserve(kptl_rx_buffer_pool_t *rxbp, int count);
342 void kptllnd_rx_buffer_pool_unreserve(kptl_rx_buffer_pool_t *rxbp, int count);
343 void kptllnd_rx_buffer_callback(ptl_event_t *ev);
344 void kptllnd_rx_buffer_post(kptl_rx_buffer_t *rxb);
347 kptllnd_rx_buffer_size(void)
349 return PAGE_SIZE * (*kptllnd_tunables.kptl_rxb_npages);
353 kptllnd_rx_buffer_addref(kptl_rx_buffer_t *rxb)
357 spin_lock_irqsave(&rxb->rxb_pool->rxbp_lock, flags);
359 spin_unlock_irqrestore(&rxb->rxb_pool->rxbp_lock, flags);
363 kptllnd_rx_buffer_decref_locked(kptl_rx_buffer_t *rxb)
365 if (--(rxb->rxb_refcount) == 0) {
366 spin_lock(&kptllnd_data.kptl_sched_lock);
368 list_add_tail(&rxb->rxb_repost_list,
369 &kptllnd_data.kptl_sched_rxbq);
370 wake_up(&kptllnd_data.kptl_sched_waitq);
372 spin_unlock(&kptllnd_data.kptl_sched_lock);
377 kptllnd_rx_buffer_decref(kptl_rx_buffer_t *rxb)
382 spin_lock_irqsave(&rxb->rxb_pool->rxbp_lock, flags);
383 count = --(rxb->rxb_refcount);
384 spin_unlock_irqrestore(&rxb->rxb_pool->rxbp_lock, flags);
387 kptllnd_rx_buffer_post(rxb);
391 * RX SUPPORT FUNCTIONS
393 void kptllnd_rx_done(kptl_rx_t *rx);
394 void kptllnd_rx_parse(kptl_rx_t *rx);
397 * PEER SUPPORT FUNCTIONS
399 int kptllnd_get_peer_info(int index,
400 lnet_process_id_t *id,
401 int *state, int *sent_hello,
402 int *refcount, __u64 *incarnation,
403 __u64 *next_matchbits, __u64 *last_matchbits_seen,
404 int *nsendq, int *nactiveq,
405 int *credits, int *outstanding_credits);
406 void kptllnd_peer_destroy(kptl_peer_t *peer);
407 int kptllnd_peer_del(lnet_process_id_t id);
408 void kptllnd_peer_close_locked(kptl_peer_t *peer, int why);
409 void kptllnd_peer_close(kptl_peer_t *peer, int why);
410 void kptllnd_handle_closing_peers(void);
411 int kptllnd_peer_connect(kptl_tx_t *tx, lnet_nid_t nid);
412 void kptllnd_peer_check_sends(kptl_peer_t *peer);
413 void kptllnd_peer_check_bucket(int idx);
414 void kptllnd_tx_launch(kptl_tx_t *tx, lnet_process_id_t target);
415 kptl_peer_t *kptllnd_peer_handle_hello(ptl_process_id_t initiator,
417 kptl_peer_t *kptllnd_id2peer_locked(lnet_process_id_t id);
418 void kptllnd_peer_alive(kptl_peer_t *peer);
421 kptllnd_peer_addref (kptl_peer_t *peer)
423 atomic_inc(&peer->peer_refcount);
427 kptllnd_peer_decref (kptl_peer_t *peer)
429 if (atomic_dec_and_test(&peer->peer_refcount))
430 kptllnd_peer_destroy(peer);
434 kptllnd_set_tx_peer(kptl_tx_t *tx, kptl_peer_t *peer)
436 LASSERT (tx->tx_peer == NULL);
438 kptllnd_peer_addref(peer);
442 static inline struct list_head *
443 kptllnd_nid2peerlist(lnet_nid_t nid)
445 unsigned int hash = ((unsigned int)nid) %
446 kptllnd_data.kptl_peer_hash_size;
448 return &kptllnd_data.kptl_peers[hash];
451 static inline kptl_peer_t *
452 kptllnd_id2peer(lnet_process_id_t id)
457 read_lock_irqsave(&kptllnd_data.kptl_peer_rw_lock, flags);
458 peer = kptllnd_id2peer_locked(id);
459 read_unlock_irqrestore(&kptllnd_data.kptl_peer_rw_lock, flags);
465 kptllnd_reserve_buffers(int n)
467 return kptllnd_rx_buffer_pool_reserve(&kptllnd_data.kptl_rx_buffer_pool,
472 kptllnd_peer_reserve_buffers(void)
474 return kptllnd_reserve_buffers(*kptllnd_tunables.kptl_peercredits);
478 kptllnd_peer_unreserve_buffers(void)
480 kptllnd_rx_buffer_pool_unreserve(&kptllnd_data.kptl_rx_buffer_pool,
481 *kptllnd_tunables.kptl_peercredits);
485 * TX SUPPORT FUNCTIONS
487 int kptllnd_setup_tx_descs(void);
488 void kptllnd_cleanup_tx_descs(void);
489 void kptllnd_tx_fini(kptl_tx_t *tx);
490 kptl_tx_t *kptllnd_get_idle_tx(enum kptl_tx_type purpose);
491 void kptllnd_tx_callback(ptl_event_t *ev);
492 const char *kptllnd_tx_typestr(int type);
495 kptllnd_tx_addref(kptl_tx_t *tx)
497 atomic_inc(&tx->tx_refcount);
501 kptllnd_tx_decref(kptl_tx_t *tx)
503 LASSERT (!in_interrupt()); /* Thread context only */
505 if (atomic_dec_and_test(&tx->tx_refcount))
510 * MESSAGE SUPPORT FUNCTIONS
512 void kptllnd_init_msg(kptl_msg_t *msg, int type, int body_nob);
513 void kptllnd_msg_pack(kptl_msg_t *msg, kptl_peer_t *peer);
514 int kptllnd_msg_unpack(kptl_msg_t *msg, int nob);
517 * MISC SUPPORT FUNCTIONS
519 void kptllnd_init_rdma_md(kptl_tx_t *tx, unsigned int niov,
520 struct iovec *iov, lnet_kiov_t *kiov,
521 unsigned int offset, unsigned int nob);
522 char *kptllnd_ptlid2str(ptl_process_id_t id);
524 void kptllnd_init_ptltrace(void);
525 void kptllnd_dump_ptltrace(void);
528 #define SIMULATION_FAIL_TX_PUT_ALLOC 0 /* 0x00000001 */
529 #define SIMULATION_FAIL_TX_GET_ALLOC 1 /* 0x00000002 */
530 #define SIMULATION_FAIL_TX 2 /* 0x00000004 */
531 #define SIMULATION_FAIL_RX_ALLOC 3 /* 0x00000008 */
533 #define IS_SIMULATION_ENABLED(x) \
534 (((*kptllnd_tunables.kptl_simulation_bitmap) & 1<< SIMULATION_##x) != 0)
536 #define IS_SIMULATION_ENABLED(x) 0