2 * Copyright (C) 2004 Cluster File Systems, Inc.
4 * Copyright (C) 2009-2012 Cray, Inc.
6 * Derived from work by: Eric Barton <eric@bartonsoftware.com>
7 * Author: Nic Henke <nic@cray.com>
8 * Author: James Shimek <jshimek@cray.com>
10 * This file is part of Lustre, http://www.lustre.org.
12 * Lustre is free software; you can redistribute it and/or
13 * modify it under the terms of version 2 of the GNU General Public
14 * License as published by the Free Software Foundation.
16 * Lustre is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with Lustre; if not, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #ifndef _GNILND_GNILND_H_
27 #define _GNILND_GNILND_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 #ifdef HAVE_LINUX_KERNEL_LOCK
36 #include <linux/smp_lock.h>
38 #include <linux/unistd.h>
39 #include <linux/uio.h>
40 #include <linux/time.h>
41 #include <asm/timex.h>
43 #include <asm/system.h>
44 #include <asm/uaccess.h>
47 #include <linux/init.h>
49 #include <linux/file.h>
50 #include <linux/stat.h>
51 #include <linux/list.h>
52 #include <linux/kmod.h>
53 #include <linux/sysctl.h>
54 #include <linux/kthread.h>
55 #include <linux/nmi.h>
59 #include <linux/nmi.h>
61 #define DEBUG_SUBSYSTEM S_LND
63 #include <libcfs/linux/kp30.h>
64 #include <libcfs/libcfs.h>
65 #include <lnet/lnet.h>
66 #include <lnet/lib-lnet.h>
69 #include "gnilnd_version.h"
72 /* tunables determined at compile time */
73 #define GNILND_MIN_TIMEOUT 5 /* minimum timeout interval (seconds) */
74 #define GNILND_TO2KA(t) (((t)-1)/2) /* timeout -> keepalive interval */
75 #define GNILND_MIN_RECONNECT_TO (GNILND_BASE_TIMEOUT/4)
76 #define GNILND_MAX_RECONNECT_TO GNILND_BASE_TIMEOUT
77 #define GNILND_HARDWARE_TIMEOUT 15 /* maximum time for data to travel between nodes */
78 #define GNILND_MDD_TIMEOUT 15 /* MDD hold timeout in minutes */
79 #define GNILND_SCHED_TIMEOUT 1
80 #define GNILND_DGRAM_TIMEOUT 2
81 #define GNILND_FAST_MAPPING_TRY \
82 *kgnilnd_tunables.kgn_max_retransmits /* maximum number to attempt mapping of a tx */
83 #define GNILND_MAP_RETRY_RATE 1 /* interval between mapping attempts in jiffies */
85 /* map failure timeout */
86 #define GNILND_MAP_TIMEOUT \
87 (cfs_time_seconds(*kgnilnd_tunables.kgn_timeout * \
88 *kgnilnd_tunables.kgn_timeout))
90 /* reaper thread wakup interval */
91 #define GNILND_REAPER_THREAD_WAKE 1
92 /* reaper thread checks each conn NCHECKS time every kgnilnd_data.kgn_new_min_timeout */
93 #define GNILND_REAPER_NCHECKS 4
96 #define GNILND_MAXDEVS 1 /* max # of GNI devices currently supported */
97 #define GNILND_MBOX_CREDITS 256 /* number of credits per mailbox */
98 #define GNILND_COOKIE 0xa3579 /* cookie used by along with ptag by GNI */
99 #define GNILND_CONN_MAGIC 0xa100f /* magic value for verifying connection validity */
100 /* checksum values */
101 #define GNILND_CHECKSUM_OFF 0 /* checksum turned off */
102 #define GNILND_CHECKSUM_SMSG_HEADER 1 /* Only checksum SMSG header */
103 #define GNILND_CHECKSUM_SMSG 2 /* checksum entire SMSG packet */
104 #define GNILND_CHECKSUM_SMSG_BTE 3 /* Full checksum support */
106 /* tune down some COMPUTE options as they won't see the same number of connections and
107 * don't need the throughput of multiple threads by default */
108 #if defined(CONFIG_CRAY_COMPUTE)
110 #define GNILND_SCHED_THREADS 2 /* default # of kgnilnd_scheduler threads */
112 #define GNILND_SCHED_THREADS 1 /* default # of kgnilnd_scheduler threads */
114 #define GNILND_FMABLK 64 /* default number of mboxes per fmablk */
115 #define GNILND_SCHED_NICE 0 /* default nice value for scheduler threads */
116 #define GNILND_COMPUTE 1 /* compute image */
118 #define GNILND_SCHED_THREADS 3 /* default # of kgnilnd_scheduler threads */
119 #define GNILND_FMABLK 1024 /* default number of mboxes per fmablk */
120 #define GNILND_SCHED_NICE -20 /* default nice value for scheduler threads */
121 #define GNILND_COMPUTE 0 /* service image */
124 /* EXTRA_BITS are there to allow us to hide NOOP/CLOSE and anything else out of band */
125 #define GNILND_EXTRA_BITS 1
126 /* maximum number of conns & bits for cqid in the SMSG event data */
127 #define GNILND_CQID_NBITS (21 - GNILND_EXTRA_BITS)
128 #define GNILND_MSGID_TX_NBITS (32 - GNILND_CQID_NBITS)
129 #define GNILND_MAX_CQID (1 << GNILND_CQID_NBITS)
130 #define GNILND_MAX_MSG_ID (1 << GNILND_MSGID_TX_NBITS)
131 #define GNILND_MAX_MSG_SIZE (*kgnilnd_tunables.kgn_max_immediate + sizeof(kgn_msg_t))
133 /* need sane upper bound to limit copy overhead */
134 #define GNILND_MAX_IMMEDIATE (64<<10)
136 /* payload size to add to the base mailbox size
137 * This is subtracting 2 from the concurrent_sends as 4 messages are included in the size
138 * gni_smsg_buff_size_needed calculates, the MAX_PAYLOAD is added to
139 * the calculation return from that function.*/
140 #define GNILND_MBOX_PAYLOAD \
141 (GNILND_MAX_MSG_SIZE * \
142 ((*kgnilnd_tunables.kgn_concurrent_sends - 2) * 2));
144 /* timeout -> deadman timer for kgni mdd holds */
145 #define GNILND_TIMEOUT2DEADMAN ((*kgnilnd_tunables.kgn_mdd_timeout) * 1000 * 60)
147 /* timeout for failing sends in t is in jiffies*/
148 #define GNILND_TIMEOUTRX(t) (t + cfs_time_seconds(*kgnilnd_tunables.kgn_hardware_timeout))
150 /* time when to release from purgatory in the reaper thread in jiffies */
151 #define GNILND_PURG_RELEASE(t) (GNILND_TIMEOUTRX(t) * 3)
153 /* Macro for finding last_rx 2 datapoints are compared
154 * and the most recent one in jiffies is returned.
156 #define GNILND_LASTRX(conn) (time_after(conn->gnc_last_rx, conn->gnc_last_rx_cq) \
157 ? conn->gnc_last_rx : conn->gnc_last_rx_cq)
159 /************************************************************************
160 * Enum, flag and tag data
162 #define GNILND_INIT_NOTHING 0
163 #define GNILND_INIT_DATA 1
164 #define GNILND_INIT_ALL 2
166 /* If you change the ordering away from MAPPED = UNMAPPED + 1, things break */
167 #define GNILND_BUF_NONE 0 /* buffer type not set */
168 #define GNILND_BUF_IMMEDIATE 1 /* immediate data */
169 #define GNILND_BUF_IMMEDIATE_KIOV 2 /* immediate data */
170 #define GNILND_BUF_PHYS_UNMAPPED 3 /* physical: not mapped yet */
171 #define GNILND_BUF_PHYS_MAPPED 4 /* physical: mapped already */
172 #define GNILND_BUF_VIRT_UNMAPPED 5 /* virtual: not mapped yet */
173 #define GNILND_BUF_VIRT_MAPPED 6 /* virtual: mapped already */
175 #define GNILND_TX_WAITING_REPLY (1<<1) /* expecting to receive reply */
176 #define GNILND_TX_WAITING_COMPLETION (1<<2) /* waiting for smsg_send to complete */
177 #define GNILND_TX_PENDING_RDMA (1<<3) /* RDMA transaction pending until we get prev. completion */
178 #define GNILND_TX_QUIET_ERROR (1<<4) /* don't print error on tx_done */
179 #define GNILND_TX_FAIL_SMSG (1<<5) /* pass down error injection for SMSG fail */
181 /* stash above max CQID to avoid any collision */
182 #define GNILND_MSGID_NOOP (GNILND_MAX_CQID + 128)
183 #define GNILND_MSGID_CLOSE (GNILND_MSGID_NOOP + 1)
185 /* kgn_msg_t::gnm_type */
186 #define GNILND_MSG_NONE 0x00 /* illegal message */
187 #define GNILND_MSG_NOOP 0x01 /* empty gnm_u (keepalive) */
188 #define GNILND_MSG_IMMEDIATE 0x02 /* gnm_u.immediate */
189 #define GNILND_MSG_PUT_REQ 0x03 /* gnm_u.putreq (src->sink) */
190 #define GNILND_MSG_PUT_NAK 0x04 /* gnm_u.completion (no PUT match: sink->src) */
191 #define GNILND_MSG_PUT_ACK 0x05 /* gnm_u.putack (PUT matched: sink->src) */
192 #define GNILND_MSG_PUT_DONE 0x06 /* gnm_u.completion (src->sink) */
193 #define GNILND_MSG_GET_REQ 0x07 /* gnm_u.get (sink->src) */
194 #define GNILND_MSG_GET_NAK 0x08 /* gnm_u.completion (no GET match: src->sink) */
195 #define GNILND_MSG_GET_DONE 0x09 /* gnm_u.completion (src->sink) */
196 #define GNILND_MSG_CLOSE 0x0a /* empty gnm_u */
197 #define GNILND_MSG_PUT_REQ_REV 0x0b /* gnm_u.get (src->sink) */
198 #define GNILND_MSG_PUT_DONE_REV 0x0c /* gnm_u.completion (sink->src) */
199 #define GNILND_MSG_PUT_NAK_REV 0x0d /* gnm_u.completion (no PUT match: sink->src) */
200 #define GNILND_MSG_GET_REQ_REV 0x0e /* gnm_u.get (sink->src ) */
201 #define GNILND_MSG_GET_ACK_REV 0x0f /* gnm_u.getack (GET matched: src->sink) */
202 #define GNILND_MSG_GET_DONE_REV 0x10 /* gnm_u.completion (sink -> src) */
203 #define GNILND_MSG_GET_NAK_REV 0x11 /* gnm_u.completeion (no GET match: sink -> src) */
205 /* defines for gnc_*scheduled states */
206 #define GNILND_CONN_IDLE 0
207 #define GNILND_CONN_SCHED 1
208 #define GNILND_CONN_WANTS_SCHED 2
209 #define GNILND_CONN_PROCESS 3
211 #define GNILND_DEV_IDLE 0
212 #define GNILND_DEV_IRQ 1
213 #define GNILND_DEV_LOOP 2
215 #define GNILND_DGRAM_IDLE 0
216 #define GNILND_DGRAM_SCHED 1
217 #define GNILND_DGRAM_PROCESS 2
219 #define GNILND_PEER_IDLE 0
220 #define GNILND_PEER_CONNECT 1
221 #define GNILND_PEER_POSTING 2
222 #define GNILND_PEER_POSTED 3
223 #define GNILND_PEER_NEEDS_DEATH 4
224 #define GNILND_PEER_KILL 5
226 /* for gnc_close_recvd */
227 #define GNILND_CLOSE_RX 1
228 #define GNILND_CLOSE_INJECT1 2
229 #define GNILND_CLOSE_INJECT2 3
230 #define GNILND_CLOSE_EARLY 4
232 /* defines for why quiesce trigger set */
233 #define GNILND_QUIESCE_IDLE 0
234 #define GNILND_QUIESCE_ADMIN 1
235 #define GNILND_QUIESCE_RESET 2
236 #define GNILND_QUIESCE_HW_QUIESCE 3
238 #define GNILND_PEER_CLEAN 0
239 #define GNILND_PEER_PERSISTING 1
241 #define GNILND_DEL_CONN 0
242 #define GNILND_DEL_PEER 1
243 #define GNILND_CLEAR_PURGATORY 2
245 #define GNILND_RCA_NODE_UP 0
246 #define GNILND_RCA_NODE_DOWN 1
247 #define GNILND_RCA_NODE_UNKNOWN 2
249 /* defines for reverse RDMA states */
250 #define GNILND_REVERSE_NONE 0
251 #define GNILND_REVERSE_GET 1
252 #define GNILND_REVERSE_PUT 2
253 #define GNILND_REVERSE_BOTH (GNILND_REVERSE_GET | GNILND_REVERSE_PUT)
255 typedef enum kgn_fmablk_state {
256 GNILND_FMABLK_IDLE = 0, /* is allocated or ready to be freed */
257 GNILND_FMABLK_PHYS, /* allocated out of slab of physical memory */
258 GNILND_FMABLK_VIRT, /* 'standard' vmalloc hunk */
259 GNILND_FMABLK_FREED, /* after free */
260 } kgn_fmablk_state_t;
262 typedef enum kgn_tx_list_state {
263 GNILND_TX_IDLE = 0, /* TX is on the idle list, kgn_idle_txs */
264 GNILND_TX_ALLOCD, /* TX has been alloced (off of idle), could be in any state transition */
265 GNILND_TX_PEERQ, /* TX on peer->gnp_tx_queue (no live conn) */
266 GNILND_TX_MAPQ, /* TX on dev:gnd_map_tx for buffer mapping */
267 GNILND_TX_FMAQ, /* TX waiting to be send on conn FMA */
268 GNILND_TX_LIVE_FMAQ, /* TX live on the FMA wire, waiting for completion or reply */
269 GNILND_TX_RDMAQ, /* TX waiting to send FMA confirmation to auth RDMA PUT */
270 GNILND_TX_LIVE_RDMAQ, /* TX live on the RDMA wire, waiting for completion */
271 GNILND_TX_DYING, /* TX got caught on MAPQ or RDMAQ while conn was closing, needs someone to call tx_done */
272 GNILND_TX_FREED /* TX is free! */
273 } kgn_tx_list_state_t;
275 typedef enum kgn_conn_state {
276 /* don't start @ 0 - prevent memset(0) badness */
277 GNILND_CONN_DUMMY = 0,
279 GNILND_CONN_CONNECTING,
280 GNILND_CONN_ESTABLISHED,
284 GNILND_CONN_DESTROY_EP
287 /* changing these requires a change to GNILND_CONNREQ_VERSION and
288 * will result in dropped packets instead of NAKs. Adding to this is
289 * acceptable without changing the CONNREQ_VERSION, but code should
290 * be ready to handle NAKs on version mismatch */
291 typedef enum kgn_connreq_type {
292 GNILND_CONNREQ_REQ = 1, /* how YOU doin' ? */
293 GNILND_CONNREQ_NAK, /* NO soup for you! */
294 GNILND_CONNREQ_CLOSE, /* we should see other people */
295 } kgn_connreq_type_t;
297 typedef enum kgn_dgram_state {
298 /* don't use 0 to avoid thinking a memset of zero is valid data */
299 GNILND_DGRAM_USED = 1,
300 GNILND_DGRAM_POSTING,
302 GNILND_DGRAM_PROCESSING,
303 GNILND_DGRAM_CANCELED,
307 typedef enum kgn_dgram_type {
308 GNILND_DGRAM_REQ = 1, /* how YOU doin' ? */
309 GNILND_DGRAM_WC_REQ, /* you talkin' to ME? */
310 GNILND_DGRAM_NAK, /* NO soup for you! */
311 GNILND_DGRAM_CLOSE, /* we should see other people */
314 /************************************************************************
315 * Wire message structs. These are sent in sender's byte order
316 * (i.e. receiver checks magic and flips if required).
319 #define GNILND_MSG_MAGIC LNET_PROTO_GNI_MAGIC /* unique magic */
320 #define GNILND_DGRAM_MAGIC 0x0DDBA11
322 /* kgn_msg_t - FMA/SMSG wire struct
324 * - added checksum to FMA
325 * moved seq before paylod
326 * WIRE_ATTR added for alignment
328 * added gnm_payload_len for FMA payload size
330 * added gncm_retval to completion, allowing return code transmission
333 * changed how CQID and TX ids are assigned
335 * added retval on CLOSE
337 * added payload checksumming
339 * reworked checksumming a bit, changed payload checksums
341 #define GNILND_MSG_VERSION 8
342 /* kgn_connreq_t connection request datagram wire struct
347 #define GNILND_CONNREQ_VERSION 2
349 typedef struct kgn_gniparams {
350 __u32 gnpr_host_id; /* ph. host ID of the NIC */
351 __u32 gnpr_cqid; /* cqid I want peer to use when sending events to me */
352 gni_smsg_attr_t gnpr_smsg_attr; /* my short msg. attributes */
353 } WIRE_ATTR kgn_gniparams_t;
355 typedef struct kgn_nak_data {
356 __s32 gnnd_errno; /* errno reason for NAK */
358 } WIRE_ATTR kgn_nak_data_t;
360 /* the first bits of the connreq struct CANNOT CHANGE FORM EVER
361 * without breaking the ability for us to properly NAK someone */
362 typedef struct kgn_connreq { /* connection request/response */
363 __u32 gncr_magic; /* I'm an gnilnd connreq */
364 __u32 gncr_cksum; /* checksum (0 == disabled) */
365 __u16 gncr_type; /* REQ, NAK, etc */
366 __u16 gncr_version; /* this is my version number */
367 __u32 gncr_timeout; /* sender's timeout */
368 __u64 gncr_srcnid; /* sender's NID */
369 __u64 gncr_dstnid; /* who sender expects to listen */
370 __u64 gncr_peerstamp; /* sender's instance stamp */
371 __u64 gncr_connstamp; /* sender's connection stamp */
373 /* everything before this needs to stay static, adding after should
374 * result in a change to GNILND_CONNREQ_VERSION */
377 kgn_gniparams_t gncr_gnparams; /* sender's endpoint info */
378 kgn_nak_data_t gncr_nakdata; /* data (rc, etc) for NAK */
380 } WIRE_ATTR kgn_connreq_t;
383 gni_mem_handle_t gnrd_key;
386 } WIRE_ATTR kgn_rdma_desc_t;
389 lnet_hdr_t gnim_hdr; /* LNet header */
390 /* LNet payload is in FMA "Message Data" */
391 } WIRE_ATTR kgn_immediate_msg_t;
394 lnet_hdr_t gnprm_hdr; /* LNet header */
395 __u64 gnprm_cookie; /* opaque completion cookie */
396 } WIRE_ATTR kgn_putreq_msg_t;
399 __u64 gnpam_src_cookie; /* reflected completion cookie */
400 __u64 gnpam_dst_cookie; /* opaque completion cookie */
401 __u16 gnpam_payload_cksum; /* checksum for get msg */
402 kgn_rdma_desc_t gnpam_desc; /* sender's sink buffer */
403 } WIRE_ATTR kgn_putack_msg_t;
406 lnet_hdr_t gngm_hdr; /* LNet header */
407 __u64 gngm_cookie; /* opaque completion cookie */
408 __u16 gngm_payload_cksum; /* checksum for put msg */
409 kgn_rdma_desc_t gngm_desc; /* sender's sink buffer */
410 } WIRE_ATTR kgn_get_msg_t;
413 int gncm_retval; /* error on NAK, size on REQ */
414 __u64 gncm_cookie; /* reflected completion cookie */
415 } WIRE_ATTR kgn_completion_msg_t;
417 typedef struct { /* NB must fit in FMA "Prefix" */
418 __u32 gnm_magic; /* I'm an gni message */
419 __u16 gnm_version; /* this is my version number */
420 __u16 gnm_type; /* msg type */
421 __u64 gnm_srcnid; /* sender's NID */
422 __u64 gnm_connstamp; /* sender's connection stamp */
423 __u32 gnm_seq; /* incrementing sequence number */
424 __u16 gnm_cksum; /* checksum (0 == no checksum ) */
425 __u16 gnm_payload_cksum; /* payload checksum (0 == no checksum ) */
426 __u32 gnm_payload_len; /* size of the FMA payload sent */
428 kgn_immediate_msg_t immediate;
429 kgn_putreq_msg_t putreq;
430 kgn_putack_msg_t putack;
432 kgn_completion_msg_t completion;
434 } WIRE_ATTR kgn_msg_t;
436 /************************************************************************
437 * runtime tunable data
440 typedef struct kgn_tunables {
441 int *kgn_min_reconnect_interval; /* connreq starting timeout & retransmit interval */
442 int *kgn_max_reconnect_interval; /* ...exponentially increasing to this */
443 int *kgn_credits; /* # concurrent sends */
444 int *kgn_fma_cq_size; /* # entries in receive CQ */
445 int *kgn_peer_credits; /* # LNet peer credits */
446 int *kgn_concurrent_sends; /* max # of max_immediate in mbox */
447 int *kgn_timeout; /* comms timeout (seconds) */
448 int *kgn_max_immediate; /* immediate payload breakpoint */
449 int *kgn_checksum; /* checksum data */
450 int *kgn_checksum_dump; /* dump raw data to D_INFO log when checksumming */
451 int *kgn_bte_dlvr_mode; /* BTE delivery mode mask */
452 int *kgn_bte_relaxed_ordering; /* relaxed ordering (PASSPW) on BTE transfers */
453 int *kgn_ptag; /* PTAG for cdm_create */
454 int *kgn_max_retransmits; /* max number of FMA retransmits */
455 int *kgn_nwildcard; /* # wildcard per net to post */
456 int *kgn_nice; /* nice value for kgnilnd threads */
457 int *kgn_rdmaq_intervals; /* # intervals per second for rdmaq throttle */
458 int *kgn_loops; /* # of loops sched does before flush/heartbeat tickle */
459 int *kgn_peer_hash_size; /* size of kgn_peers */
460 int *kgn_peer_health; /* enable/disable peer health */
461 int *kgn_peer_timeout; /* Override of the default peer_timeout used by peer_health */
462 int *kgn_vmap_cksum; /* enable/disable vmap of kiov checksums */
463 int *kgn_mbox_per_block; /* mailboxes per fmablk */
464 int *kgn_nphys_mbox; /* # mailboxes to preallocate with physical memory */
465 int *kgn_mbox_credits; /* max credits per fma */
466 int *kgn_sched_threads; /* number of kgnilnd_scheduler threads */
467 int *kgn_net_hash_size; /* size of kgn_net_ht */
468 int *kgn_hardware_timeout; /* max time for a message to get across the network */
469 int *kgn_mdd_timeout; /* max time for ghal to hold an mdd in minutes */
470 int *kgn_sched_timeout; /* max time for scheduler to run before yielding */
471 int *kgn_dgram_timeout; /* max time for dgram mover to run before scheduling */
472 int *kgn_sched_nice; /* nice value for kgnilnd scheduler threads */
473 int *kgn_reverse_rdma; /* Reverse RDMA setting */
474 int *kgn_eager_credits; /* allocated eager buffers */
475 int *kgn_efault_lbug; /* Should we LBUG on receiving an EFAULT */
476 #if CONFIG_SYSCTL && !CFS_SYSFS_MODULE_PARM
477 cfs_sysctl_table_header_t *kgn_sysctl; /* sysctl interface */
481 typedef struct kgn_mbox_info {
482 lnet_nid_t mbx_prev_nid;
483 lnet_nid_t mbx_prev_purg_nid;
484 unsigned long mbx_create_conn_memset;
485 unsigned long mbx_add_purgatory;
486 unsigned long mbx_detach_of_purgatory;
487 unsigned long mbx_release_from_purgatory;
488 unsigned long mbx_release_purg_active_dgram;
490 int mbx_nallocs_total;
493 typedef struct kgn_fma_memblock {
494 struct list_head gnm_bufflist; /* memblock is part of device's gnd_fma_buffs */
495 kgn_fmablk_state_t gnm_state; /* how this memory allocated & state of it */
496 int gnm_hold_timeout; /* hold_timeout if used at unmap time */
497 int gnm_num_mboxs; /* total mboxes allocated */
498 int gnm_avail_mboxs; /* number of available mailboxes in the block */
499 int gnm_held_mboxs; /* number of purgatory held mailboxes */
500 int gnm_mbox_size; /* size of the single mailbox */
501 int gnm_next_avail_mbox; /* next available mailbox */
502 long gnm_max_timeout; /* max timeout for possible purgatory hold */
503 unsigned int gnm_blk_size; /* how big is our hunk o memory ? */
504 void *gnm_block; /* pointer to mem. block */
505 gni_mem_handle_t gnm_hndl; /* mem. handle of the block */
506 unsigned long *gnm_bit_array; /* bit array tracking allocation of mailboxes */
507 kgn_mbox_info_t *gnm_mbox_info; /* array of mbox_information about each mbox */
508 } kgn_fma_memblock_t;
510 typedef struct kgn_device {
511 gni_nic_handle_t gnd_handle; /* device handle */
512 gni_cdm_handle_t gnd_domain; /* GNI communication domain */
513 gni_err_handle_t gnd_err_handle; /* device error handle */
514 unsigned long gnd_sched_alive; /* scheduler thread alive stamp */
515 gni_cq_handle_t gnd_rcv_fma_cqh; /* FMA rcv. completion queue handle */
516 gni_cq_handle_t gnd_snd_rdma_cqh; /* rdma send completion queue handle */
517 gni_cq_handle_t gnd_snd_fma_cqh; /* rdma send completion queue handle */
518 struct mutex gnd_cq_mutex; /* CQ access serialization */
519 __u32 gnd_host_id; /* ph. host ID of the NIC */
520 int gnd_id; /* device id, also index in kgn_devices */
521 __u32 gnd_nid; /* ph host ID translated to NID */
522 struct list_head gnd_fma_buffs; /* list of FMA memory blocks */
523 struct mutex gnd_fmablk_mutex; /* mutex for FMA block memory alloc/free */
524 spinlock_t gnd_fmablk_lock; /* lock for mbox alloc/release */
525 atomic_t gnd_nfmablk; /* # of fmablk live */
526 atomic_t gnd_fmablk_vers; /* gnd_fma_bufs stamp */
527 atomic_t gnd_neps; /* # EP allocated to conns */
528 short gnd_ready; /* stuff to do in scheduler thread */
529 struct list_head gnd_ready_conns; /* connections ready to tx/rx */
530 struct list_head gnd_map_tx; /* TX: needing buffer mapping */
531 wait_queue_head_t gnd_waitq; /* scheduler wakeup */
532 spinlock_t gnd_lock; /* serialise gnd_ready_conns */
533 struct list_head gnd_connd_peers; /* peers waiting for a connection */
534 spinlock_t gnd_connd_lock; /* serialise connd_peers */
535 wait_queue_head_t gnd_dgram_waitq; /* dgram_mover thread wakeup */
536 wait_queue_head_t gnd_dgping_waitq; /* dgram thread ping-pong */
537 int gnd_dgram_ready; /* dgrams need movin' */
538 struct list_head *gnd_dgrams; /* nid hash to dgrams */
539 atomic_t gnd_ndgrams; /* # dgrams extant */
540 atomic_t gnd_nwcdgrams; /* # wildcard dgrams to post on device */
541 spinlock_t gnd_dgram_lock; /* serialize gnd_dgrams */
542 struct list_head gnd_map_list; /* list of all mapped regions */
543 int gnd_map_version; /* version flag for map list */
544 struct timer_list gnd_map_timer; /* wakey-wakey */
545 atomic_t gnd_n_mdd; /* number of total MDD - fma, tx, etc */
546 atomic_t gnd_n_mdd_held; /* number of total MDD held - fma, tx, etc */
547 atomic_t gnd_nq_map; /* # queued waiting for mapping (MDD/GART) */
548 atomic64_t gnd_nbytes_map; /* bytes of total GART maps - fma, tx, etc */
549 __u32 gnd_map_nphys; /* # TX phys mappings */
550 __u32 gnd_map_physnop; /* # TX phys pages mapped */
551 __u32 gnd_map_nvirt; /* # TX virt mappings */
552 __u64 gnd_map_virtnob; /* # TX virt bytes mapped */
553 spinlock_t gnd_map_lock; /* serialize gnd_map_XXX */
554 unsigned long gnd_next_map; /* next mapping attempt in jiffies */
555 int gnd_map_attempt; /* last map attempt # */
556 unsigned long gnd_last_map; /* map timeout base */
557 struct list_head gnd_rdmaq; /* RDMA to be sent */
558 spinlock_t gnd_rdmaq_lock; /* play nice with others */
559 atomic64_t gnd_rdmaq_bytes_out; /* # bytes authorized */
560 atomic64_t gnd_rdmaq_bytes_ok; /* # bytes allowed until deadline */
561 atomic_t gnd_rdmaq_nstalls; /* # stalls due to throttle */
562 unsigned long gnd_rdmaq_deadline; /* when does bucket roll over ? */
563 struct timer_list gnd_rdmaq_timer; /* wakey-wakey */
564 atomic_t gnd_short_ntx; /* TX stats: short messages */
565 atomic64_t gnd_short_txbytes; /* TX stats: short message payload*/
566 atomic_t gnd_rdma_ntx; /* TX stats: rdma messages */
567 atomic64_t gnd_rdma_txbytes; /* TX stats: rdma message payload*/
568 atomic_t gnd_short_nrx; /* RX stats: short messages */
569 atomic64_t gnd_short_rxbytes; /* RX stats: short message payload*/
570 atomic_t gnd_rdma_nrx; /* RX stats: rdma messages */
571 atomic64_t gnd_rdma_rxbytes; /* RX stats: rdma message payload*/
572 atomic_t gnd_fast_try; /* # of times fast send tried */
573 atomic_t gnd_fast_ok; /* # of times fast send ok */
574 atomic_t gnd_fast_block; /* # of times fast send blocked */
575 unsigned long gnd_mutex_delay;
576 atomic_t gnd_n_yield;
577 atomic_t gnd_n_schedule;
578 atomic_t gnd_canceled_dgrams; /* # of outstanding cancels */
579 struct rw_semaphore gnd_conn_sem; /* serialize connection changes/data movement */
582 typedef struct kgn_net {
583 struct list_head gnn_list; /* chain on kgni_data::kgn_nets */
584 kgn_device_t *gnn_dev; /* device for this net */
585 lnet_ni_t *gnn_ni; /* network interface instance */
586 atomic_t gnn_refcount; /* # current references */
587 int gnn_shutdown; /* lnd_shutdown set */
588 __u16 gnn_netnum; /* stash netnum for quicker lookup */
591 static inline lnet_nid_t
592 kgnilnd_lnd2lnetnid(lnet_nid_t ni_nid, lnet_nid_t kgnilnd_nid)
594 return LNET_MKNID(LNET_NIDNET(ni_nid), LNET_NIDADDR(kgnilnd_nid));
597 static inline lnet_nid_t
598 kgnilnd_lnet2lndnid(lnet_nid_t lnet_nid, lnet_nid_t kgnilnd_nid)
600 return LNET_MKNID(LNET_NIDNET(kgnilnd_nid), LNET_NIDADDR(lnet_nid));
603 /* The code for this is a bit ugly - but really this just boils down to a __u64
604 * that can have various parts accessed separately.
606 * The lower 32 bits is the ID
607 * we give to SMSG for our completion event - it needs to be globally unique across
608 * all TX currently in flight. We separate that out into the CQID so that we can
609 * reference the connection (kgnilnd_cqid2conn_locked) and then the msg_id to pull
610 * the actual TX out of the per-connection gnc_tx_ref_table.
612 * The upper 32 bits are just extra stuff we put into the cookie to ensure this TX
613 * has a unique value we can send with RDMA setup messages to ensure the completion for
614 * those is unique across the wire. The extra 32 bits are there to ensure that TX id
615 * reuse is separated.
618 typedef struct kgn_tx_ev_id {
620 __u64 txe_cookie; /* are you my mommy ? */
622 __u32 txe_chips; /* extra bits to ensure ID unique across reuse */
624 __u32 txe_smsg_id; /* ID for SMSG CQ event */
625 /* N.B: Never ever ever ever use the bit shifts directly,
626 * you are just asking for a world of pain and are at the
627 * mercy of the compiler layouts */
629 __u32 txe_cqid :GNILND_CQID_NBITS;
630 __u32 txe_idx :GNILND_MSGID_TX_NBITS;
637 typedef struct kgn_dgram {
638 struct list_head gndg_list; /* on hash dev::gnd_dgrams */
639 kgn_dgram_state_t gndg_state; /* state of this dgram */
640 kgn_dgram_type_t gndg_type; /* REQ, NAK, etc */
641 __u32 gndg_magic; /* saftey word */
642 unsigned long gndg_post_time; /* time when we posted */
643 struct kgn_conn *gndg_conn; /* unbound conn with ep & smsg */
644 kgn_connreq_t gndg_conn_out; /* connreq from local node */
645 kgn_connreq_t gndg_conn_in; /* connreq from remote node */
648 typedef struct kgn_tx { /* message descriptor */
649 struct list_head tx_list; /* TX queues - peer, conn, rdma */
650 kgn_tx_list_state_t tx_list_state;/* where in state machine is this TX ? */
651 struct list_head *tx_list_p; /* pointer to current list */
652 struct kgn_conn *tx_conn; /* owning conn */
653 lnet_msg_t *tx_lntmsg[2]; /* ptl msgs to finalize on completion */
654 unsigned long tx_qtime; /* when tx started to wait for something (jiffies) */
655 unsigned long tx_cred_wait; /* time spend waiting for smsg creds */
656 struct list_head tx_map_list; /* list entry on device map list */
657 unsigned int tx_nob; /* # bytes of payload */
658 int tx_buftype; /* payload buffer type */
659 int tx_phys_npages; /* # physical pages */
660 gni_mem_handle_t tx_map_key; /* mapping key */
661 gni_mem_handle_t tx_buffer_copy_map_key; /* mapping key for page aligned copy */
662 gni_mem_segment_t *tx_phys; /* page descriptors */
663 kgn_msg_t tx_msg; /* FMA message buffer */
664 kgn_tx_ev_id_t tx_id; /* who are you, who ? who ? */
665 __u8 tx_state; /* state of the descriptor */
666 int tx_retrans; /* retrans count of RDMA */
667 int tx_rc; /* if we need to stash the ret code until we see completion */
668 void *tx_buffer; /* source/sink buffer */
669 void *tx_buffer_copy; /* pointer to page aligned buffer */
670 unsigned int tx_nob_rdma; /* nob actually rdma */
671 unsigned int tx_offset; /* offset of data into copied buffer */
673 gni_post_descriptor_t tx_rdma_desc; /* rdma descriptor */
674 struct page *tx_imm_pages[GNILND_MAX_IMMEDIATE/PAGE_SIZE]; /* page array to map kiov for immediate send */
677 /* we only use one or the other */
679 kgn_putack_msg_t tx_putinfo; /* data for differed rdma & re-try */
680 kgn_get_msg_t tx_getinfo; /* data for rdma re-try*/
684 typedef struct kgn_conn {
685 kgn_device_t *gnc_device; /* which device */
686 struct kgn_peer *gnc_peer; /* owning peer */
687 int gnc_magic; /* magic value cleared before free */
688 struct list_head gnc_list; /* stash on peer's conn list - or pending purgatory lists as we clear them */
689 struct list_head gnc_hashlist; /* stash in connection hash table */
690 struct list_head gnc_schedlist; /* schedule (on gnd_?_conns) for attention */
691 struct list_head gnc_fmaq; /* txs queued for FMA */
692 struct list_head gnc_mdd_list; /* hold list for MDD on hard conn reset */
693 __u64 gnc_peerstamp; /* peer's unique stamp */
694 __u64 gnc_peer_connstamp; /* peer's unique connection stamp */
695 __u64 gnc_my_connstamp; /* my unique connection stamp */
696 unsigned long gnc_first_rx; /* when I first received an FMA message (jiffies) */
697 unsigned long gnc_last_tx; /* when I last sent an FMA message (jiffies) */
698 unsigned long gnc_last_rx; /* when I last sent an FMA message (jiffies) */
699 unsigned long gnc_last_tx_cq; /* when I last received an FMA CQ (jiffies) */
700 unsigned long gnc_last_rx_cq; /* when I last received an FMA CQ (jiffies) */
701 unsigned long gnc_last_noop_want; /* time I wanted to send NOOP */
702 unsigned long gnc_last_noop_sent; /* time I did gni_smsg_send on NOOP */
703 unsigned long gnc_last_noop_cq; /* time when NOOP completed */
704 unsigned long gnc_last_sched_ask; /* time when conn added to ready_conns */
705 unsigned long gnc_last_sched_do; /* time when conn processed from ready_conns */
706 atomic_t gnc_reaper_noop; /* # reaper triggered NOOP */
707 atomic_t gnc_sched_noop; /* # sched triggered NOOP */
708 unsigned int gnc_timeout; /* infer peer death if no rx for this many seconds */
709 __u32 gnc_cqid; /* my completion callback id (non-unique) */
710 __u32 gnc_tx_seq; /* tx msg sequence number */
711 __u32 gnc_rx_seq; /* rx msg sequence number */
712 __u64 gnc_tx_retrans; /* # retrans on SMSG */
713 atomic_t gnc_nlive_fma; /* # live FMA */
714 atomic_t gnc_nq_rdma; /* # queued (on device) RDMA */
715 atomic_t gnc_nlive_rdma; /* # live RDMA */
716 short gnc_close_sent; /* I've sent CLOSE */
717 short gnc_close_recvd; /* I've received CLOSE */
718 short gnc_in_purgatory; /* in the sin bin */
719 int gnc_error; /* errno when conn being closed due to error */
720 int gnc_peer_error; /* errno peer sent us on CLOSE */
721 kgn_conn_state_t gnc_state; /* connection state */
722 int gnc_scheduled; /* being attented to */
723 char gnc_sched_caller[30]; /* what function last called schedule */
724 int gnc_sched_line; /* what line # last called schedule */
725 atomic_t gnc_refcount; /* # users */
726 spinlock_t gnc_list_lock; /* serialise tx lists, max_rx_age */
727 gni_ep_handle_t gnc_ephandle; /* GNI endpoint */
728 kgn_fma_memblock_t *gnc_fma_blk; /* pointer to fma block for our mailbox */
729 gni_smsg_attr_t gnpr_smsg_attr; /* my short msg. attributes */
730 spinlock_t gnc_tx_lock; /* protect tx alloc/free */
731 __u8 gnc_tx_bits[GNILND_MAX_MSG_ID/8]; /* bit table for tx id */
732 int gnc_next_tx; /* next tx to use in tx_ref_table */
733 kgn_tx_t **gnc_tx_ref_table; /* table of TX descriptors for this conn */
734 int gnc_mbox_id; /* id of mbox in fma_blk */
735 short gnc_needs_detach; /* flag set in detach_purgatory_all_locked so reaper will clear out purgatory */
736 short gnc_needs_closing; /* flag set in del_conns when called from kgnilnd_del_peer_or_conn */
737 atomic_t gnc_tx_in_use; /* # of tx's currently in use by another thread use kgnilnd_peer_conn_lock */
738 kgn_dgram_type_t gnc_dgram_type; /* save dgram type used to establish this conn */
739 void *remote_mbox_addr; /* save remote mbox address */
742 typedef struct kgn_mdd_purgatory {
743 gni_mem_handle_t gmp_map_key; /* mapping key */
744 struct list_head gmp_list; /* entry point for purgatory list */
745 } kgn_mdd_purgatory_t;
747 typedef struct kgn_peer {
748 struct list_head gnp_list; /* stash on global peer list */
749 struct list_head gnp_connd_list; /* schedule on kgn_connd_peers */
750 struct list_head gnp_conns; /* all active connections and all conns in purgatory for the peer */
751 struct list_head gnp_tx_queue; /* msgs waiting for a conn */
752 kgn_net_t *gnp_net; /* net instance for this peer */
753 lnet_nid_t gnp_nid; /* who's on the other end(s) */
754 atomic_t gnp_refcount; /* # users */
755 __u32 gnp_host_id; /* ph. host ID of the peer */
756 short gnp_connecting; /* connection forming */
757 short gnp_pending_unlink; /* need last conn close to trigger unlink */
758 int gnp_last_errno; /* last error conn saw */
759 unsigned long gnp_last_alive; /* last time I had valid comms */
760 int gnp_last_dgram_errno; /* last error dgrams saw */
761 unsigned long gnp_last_dgram_time; /* last time I tried to connect */
762 unsigned long gnp_reconnect_time; /* get_seconds() when reconnect OK */
763 unsigned long gnp_reconnect_interval; /* exponential backoff */
764 atomic_t gnp_dirty_eps; /* # of old but yet to be destroyed EPs from conns */
765 int gnp_down; /* rca says peer down */
766 unsigned long gnp_down_event_time; /* time peer down */
767 unsigned long gnp_up_event_time; /* time peer back up */
770 /* the kgn_rx_t is a struct for handing to LNET as the private pointer for things
771 * like lnet_parse. It allows a single pointer to let us get enough
772 * information in _recv and friends */
773 typedef struct kgn_rx {
774 kgn_conn_t *grx_conn; /* connection */
775 kgn_msg_t *grx_msg; /* message */
776 lnet_msg_t *grx_lntmsg; /* lnet msg for this rx (eager only) */
777 int grx_eager; /* if eager, we copied msg to somewhere */
778 struct timespec grx_received; /* time this msg received */
781 typedef struct kgn_data {
782 int kgn_init; /* initialisation state */
783 int kgn_shutdown; /* shut down? */
784 int kgn_wc_kill; /* Should I repost the WC */
785 atomic_t kgn_nthreads; /* # live threads */
786 int kgn_nresets; /* number of stack resets */
787 int kgn_in_reset; /* are we in stack reset ? */
789 __u64 kgn_nid_trans_private;/* private data for each of the HW nid2nic arenas */
791 kgn_device_t kgn_devices[GNILND_MAXDEVS]; /* device/ptag/cq etc */
792 int kgn_ndevs; /* # devices */
794 int kgn_ruhroh_running; /* ruhroh thread is running */
795 int kgn_ruhroh_shutdown; /* ruhroh thread should or is shut down */
796 wait_queue_head_t kgn_ruhroh_waitq; /* ruhroh thread wakeup */
797 int kgn_quiesce_trigger; /* should we quiesce ? */
798 atomic_t kgn_nquiesce; /* how many quiesced ? */
799 struct mutex kgn_quiesce_mutex; /* serialize ruhroh task, startup and shutdown */
800 int kgn_needs_reset; /* we need stack reset */
802 /* These next three members implement communication from gnilnd into
803 * the ruhroh task. To ensure correct operation of the task, code that
804 * writes into them must use memory barriers to ensure that the changes
805 * are visible to other cores in the order the members appear below. */
806 __u32 kgn_quiesce_secs; /* seconds to bump timeouts */
807 int kgn_bump_info_rdy; /* we have info needed to bump */
808 int kgn_needs_pause; /* we need to pause for network quiesce */
810 struct list_head *kgn_nets; /* hashtable of kgn_net instances */
811 struct rw_semaphore kgn_net_rw_sem; /* serialise gnn_shutdown, kgn_nets */
813 rwlock_t kgn_peer_conn_lock; /* stabilize peer/conn ops */
814 struct list_head *kgn_peers; /* hash table of all my known peers */
815 atomic_t kgn_npeers; /* # peers extant */
816 int kgn_peer_version; /* version flag for peer tables */
818 struct list_head *kgn_conns; /* conns hashed by cqid */
819 atomic_t kgn_nconns; /* # connections extant */
820 atomic_t kgn_neager_allocs; /* # of eager allocations */
821 __u64 kgn_peerstamp; /* when I started up */
822 __u64 kgn_connstamp; /* conn stamp generator */
823 int kgn_conn_version; /* version flag for conn tables */
824 int kgn_next_cqid; /* cqid generator */
826 long kgn_new_min_timeout; /* minimum timeout on any new conn */
827 wait_queue_head_t kgn_reaper_waitq; /* reaper sleeps here */
828 spinlock_t kgn_reaper_lock; /* serialise */
830 struct kmem_cache *kgn_rx_cache; /* rx descriptor space */
831 struct kmem_cache *kgn_tx_cache; /* tx descriptor memory */
832 struct kmem_cache *kgn_tx_phys_cache; /* tx phys descriptor memory */
833 atomic_t kgn_ntx; /* # tx in use */
834 struct kmem_cache *kgn_dgram_cache; /* outgoing datagrams */
836 struct page ***kgn_cksum_map_pages; /* page arrays for mapping pages on checksum */
837 __u64 kgn_cksum_npages; /* Number of pages allocated for checksumming */
838 atomic_t kgn_nvmap_cksum; /* # times we vmapped for checksums */
839 atomic_t kgn_nvmap_short; /* # times we vmapped for short kiov */
841 atomic_t kgn_nkmap_short; /* # time we kmapped for a short kiov */
842 long kgn_rdmaq_override; /* bytes per second override */
844 struct kmem_cache *kgn_mbox_cache; /* mailboxes from not-GART */
846 atomic_t kgn_npending_unlink; /* # of peers pending unlink */
847 atomic_t kgn_npending_conns; /* # of conns with pending closes */
848 atomic_t kgn_npending_detach; /* # of conns with a pending detach */
849 unsigned long kgn_last_scheduled; /* last time schedule was called in a sched thread */
850 unsigned long kgn_last_condresched; /* last time cond_resched was called in a sched thread */
851 atomic_t kgn_rev_offset; /* number of time REV rdma have been misaligned offsets */
852 atomic_t kgn_rev_length; /* Number of times REV rdma have been misaligned lengths */
853 atomic_t kgn_rev_copy_buff; /* Number of times REV rdma have had to make a copy buffer */
854 struct socket *kgn_sock; /* for Apollo */
857 extern kgn_data_t kgnilnd_data;
858 extern kgn_tunables_t kgnilnd_tunables;
860 extern void kgnilnd_destroy_peer(kgn_peer_t *peer);
861 extern void kgnilnd_destroy_conn(kgn_conn_t *conn);
862 extern int _kgnilnd_schedule_conn(kgn_conn_t *conn, const char *caller, int line, int refheld);
864 /* Macro wrapper for _kgnilnd_schedule_conn. This will store the function
865 * and the line of the calling function to allow us to debug problematic
866 * schedule calls in the future without the programmer having to mark
867 * the location manually.
869 #define kgnilnd_schedule_conn(conn) \
870 _kgnilnd_schedule_conn(conn, __func__, __LINE__, 0);
872 #define kgnilnd_schedule_conn_refheld(conn, refheld) \
873 _kgnilnd_schedule_conn(conn, __func__, __LINE__, refheld);
876 kgnilnd_thread_start(int(*fn)(void *arg), void *arg, char *name, int id)
878 struct task_struct *thrd = kthread_run(fn, arg, "%s_%02d", name, id);
880 return PTR_ERR(thrd);
882 atomic_inc(&kgnilnd_data.kgn_nthreads);
887 kgnilnd_thread_fini(void)
889 atomic_dec(&kgnilnd_data.kgn_nthreads);
892 /* like mutex_trylock but with a jiffies spinner. This is to allow certain
893 * parts of the code to avoid a scheduler trip when the mutex is held
895 * Try to acquire the mutex atomically for 1 jiffie. Returns 1 if the mutex
896 * has been acquired successfully, and 0 on contention.
898 * NOTE: this function follows the spin_trylock() convention, so
899 * it is negated to the down_trylock() return values! Be careful
900 * about this when converting semaphore users to mutexes.
902 * This function must not be used in interrupt context. The
903 * mutex must be released by the same task that acquired it.
905 static inline int kgnilnd_mutex_trylock(struct mutex *lock)
908 unsigned long timeout;
910 LASSERT(!in_interrupt());
912 for (timeout = jiffies + 1; time_before(jiffies, timeout);) {
914 ret = mutex_trylock(lock);
921 /* Copied from DEBUG_REQ in Lustre - the dance is needed to save stack space */
924 _kgnilnd_debug_msg(kgn_msg_t *msg,
925 struct libcfs_debug_msg_data *data, const char *fmt, ... );
927 #define kgnilnd_debug_msg(msgdata, mask, cdls, msg, fmt, a...) \
929 CFS_CHECK_STACK(msgdata, mask, cdls); \
931 if (((mask) & D_CANTMASK) != 0 || \
932 ((libcfs_debug & (mask)) != 0 && \
933 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
934 _kgnilnd_debug_msg((msg), msgdata, fmt, ##a); \
937 /* for most callers (level is a constant) this is resolved at compile time */
938 #define GNIDBG_MSG(level, msg, fmt, args...) \
940 if ((level) & (D_ERROR | D_WARNING | D_NETERROR)) { \
941 static cfs_debug_limit_state_t cdls; \
942 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, &cdls); \
943 kgnilnd_debug_msg(&msgdata, level, &cdls, msg, \
944 "$$ "fmt" from %s ", ## args, \
945 libcfs_nid2str((msg)->gnm_srcnid)); \
947 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, NULL); \
948 kgnilnd_debug_msg(&msgdata, level, NULL, msg, \
949 "$$ "fmt" from %s ", ## args, \
950 libcfs_nid2str((msg)->gnm_srcnid)); \
954 /* user puts 'to nid' in msg for us */
955 #define GNIDBG_TOMSG(level, msg, fmt, args...) \
957 if ((level) & (D_ERROR | D_WARNING | D_NETERROR)) { \
958 static cfs_debug_limit_state_t cdls; \
959 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, &cdls); \
960 kgnilnd_debug_msg(&msgdata, level, &cdls, msg, \
961 "$$ "fmt" ", ## args); \
963 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, NULL); \
964 kgnilnd_debug_msg(&msgdata, level, NULL, msg, \
965 "$$ "fmt" ", ## args); \
970 _kgnilnd_debug_conn(kgn_conn_t *conn,
971 struct libcfs_debug_msg_data *data, const char *fmt, ... );
973 #define kgnilnd_debug_conn(msgdata, mask, cdls, conn, fmt, a...) \
975 CFS_CHECK_STACK(msgdata, mask, cdls); \
977 if (((mask) & D_CANTMASK) != 0 || \
978 ((libcfs_debug & (mask)) != 0 && \
979 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
980 _kgnilnd_debug_conn((conn), msgdata, fmt, ##a); \
983 /* for most callers (level is a constant) this is resolved at compile time */
984 #define GNIDBG_CONN(level, conn, fmt, args...) \
986 if ((level) & (D_ERROR | D_WARNING | D_NETERROR)) { \
987 static cfs_debug_limit_state_t cdls; \
988 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, &cdls); \
989 kgnilnd_debug_conn(&msgdata, level, &cdls, conn, \
990 "$$ "fmt" ", ## args); \
992 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, NULL); \
993 kgnilnd_debug_conn(&msgdata, level, NULL, conn, \
994 "$$ "fmt" ", ## args); \
999 _kgnilnd_debug_tx(kgn_tx_t *tx,
1000 struct libcfs_debug_msg_data *data, const char *fmt, ... );
1002 #define kgnilnd_debug_tx(msgdata, mask, cdls, tx, fmt, a...) \
1004 CFS_CHECK_STACK(msgdata, mask, cdls); \
1006 if (((mask) & D_CANTMASK) != 0 || \
1007 ((libcfs_debug & (mask)) != 0 && \
1008 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
1009 _kgnilnd_debug_tx((tx), msgdata, fmt, ##a); \
1012 /* for most callers (level is a constant) this is resolved at compile time */
1013 #define GNIDBG_TX(level, tx, fmt, args...) \
1015 if ((level) & (D_ERROR | D_WARNING | D_NETERROR)) { \
1016 static cfs_debug_limit_state_t cdls; \
1017 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, &cdls); \
1018 kgnilnd_debug_tx(&msgdata, level, &cdls, tx, \
1019 "$$ "fmt" ", ## args); \
1021 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, level, NULL); \
1022 kgnilnd_debug_tx(&msgdata, level, NULL, tx, \
1023 "$$ "fmt" ", ## args); \
1027 #define GNITX_ASSERTF(tx, cond, fmt, a...) \
1029 if (unlikely(!(cond))) { \
1030 GNIDBG_TX(D_EMERG, tx, "ASSERTION(" #cond ") failed:" fmt, a); \
1035 #define GNILND_IS_QUIESCED \
1036 (atomic_read(&kgnilnd_data.kgn_nquiesce) == \
1037 atomic_read(&kgnilnd_data.kgn_nthreads))
1039 #define KGNILND_SPIN_QUIESCE \
1041 /* E.T phone home */ \
1042 atomic_inc(&kgnilnd_data.kgn_nquiesce); \
1043 CDEBUG(D_NET, "Waiting for thread pause to be over...\n"); \
1044 while (kgnilnd_data.kgn_quiesce_trigger) { \
1045 set_current_state(TASK_INTERRUPTIBLE); \
1046 schedule_timeout(HZ); \
1048 /* Mom, my homework is done */ \
1049 CDEBUG(D_NET, "Waking up from thread pause\n"); \
1050 atomic_dec(&kgnilnd_data.kgn_nquiesce); \
1053 /* use macros for addref/decref to get the calling function name in the CDEBUG */
1054 #ifndef LIBCFS_DEBUG
1055 #error "this code uses actions inside LASSERT for ref counting"
1058 #define kgnilnd_admin_addref(atomic) \
1060 int val = atomic_inc_return(&atomic); \
1061 LASSERTF(val > 0, #atomic " refcount %d\n", val); \
1062 CDEBUG(D_NETTRACE, #atomic " refcount %d\n", val); \
1065 #define kgnilnd_admin_decref(atomic) \
1067 int val = atomic_dec_return(&atomic); \
1068 LASSERTF(val >=0, #atomic " refcount %d\n", val); \
1069 CDEBUG(D_NETTRACE, #atomic " refcount %d\n", val); \
1072 #define kgnilnd_net_addref(net) \
1074 int val = atomic_inc_return(&net->gnn_refcount); \
1075 LASSERTF(val > 1, "net %p refcount %d\n", net, val); \
1076 CDEBUG(D_NETTRACE, "net %p->%s++ (%d)\n", net, \
1077 libcfs_nid2str(net->gnn_ni->ni_nid), val); \
1080 #define kgnilnd_net_decref(net) \
1082 int val = atomic_dec_return(&net->gnn_refcount); \
1083 LASSERTF(val >= 0, "net %p refcount %d\n", net, val); \
1084 CDEBUG(D_NETTRACE, "net %p->%s-- (%d)\n", net, \
1085 libcfs_nid2str(net->gnn_ni->ni_nid), val); \
1088 #define kgnilnd_peer_addref(peer) \
1090 int val = atomic_inc_return(&peer->gnp_refcount); \
1091 LASSERTF(val > 1, "peer %p refcount %d\n", peer, val); \
1092 CDEBUG(D_NETTRACE, "peer %p->%s++ (%d)\n", peer, \
1093 libcfs_nid2str(peer->gnp_nid), val); \
1096 #define kgnilnd_peer_decref(peer) \
1098 int val = atomic_dec_return(&peer->gnp_refcount); \
1099 LASSERTF(val >= 0, "peer %p refcount %d\n", peer, val); \
1100 CDEBUG(D_NETTRACE, "peer %p->%s--(%d)\n", peer, \
1101 libcfs_nid2str(peer->gnp_nid), val); \
1103 kgnilnd_destroy_peer(peer); \
1106 #define kgnilnd_conn_addref(conn) \
1111 val = atomic_inc_return(&conn->gnc_refcount); \
1112 LASSERTF(val > 1 && conn->gnc_magic == GNILND_CONN_MAGIC, \
1113 "conn %p refc %d to %s\n", \
1116 ? libcfs_nid2str(conn->gnc_peer->gnp_nid) \
1118 CDEBUG(D_NETTRACE, "conn %p->%s++ (%d)\n", conn, \
1120 ? libcfs_nid2str(conn->gnc_peer->gnp_nid) \
1125 /* we hijack conn_decref && gnc_refcount = 1 to allow us to push the conn
1126 * through the scheduler thread to get the EP destroyed. This avoids some
1127 * messy semaphore business and allows us to reuse the connd_list and existing
1128 * linkage and avoid creating extra lists just for destroying EPs */
1130 /* Safety Disclaimer:
1131 * Q: If we decrement the refcount and then check it again, is it possible that
1132 * another caller could have passed through this macro concurrently? If so,
1133 * then it is possible that both will attempt to call kgnilnd_destroy_conn().
1135 * A: Yes, entirely possible in most cases, but we can't get concurrent users
1136 * once we are refcount <= 2. It hinges around gnc_state and membership of
1137 * gnc_hashlist. There are two ways to find a connection - either ask for
1138 * it from the peer, kgnilnd_find_conn_locked(peer) or from the CQ id,
1139 * kgnilnd_cqid2conn_locked(id). While a conn is live, we'll have at least
1142 * - #1 from create (kgnilnd_create_conn)
1143 * - #2 for EP (kgnilnd_create_conn)
1144 * - #3 - living on peer (gnc_list, kgnilnd_finish_connect)
1145 * - #4 living in global hash (gnc_hashlist, kgnilnd_finish_connect).
1147 * Actually, only 3 live, as at the end of kgnilnd_finish_connect, we drop:
1148 * - #1 - the ref the dgram inherited from kgnilnd_create_conn.
1150 * There could be more from TX descriptors during the lifetime of a live
1153 * If we nuke the conn before finish_connect, we won't have parallel paths
1154 * because nobody besides the dgram handler for the single outstanding
1155 * dgram can find the connection as it isn't in any searchable tables yet.
1157 * This leaves connection close, we'll drop 2 refs (#4 and #3) but only
1158 * after calling kgnilnd_schedule_conn, which would add a new ref (#5). At
1159 * this point gnc_refcount=2 (#2, #5). We have a 'maybe' send of the CLOSE
1160 * now on the next scheduler loop, this could be #6 (schedule_conn again)
1161 * and #7 (TX on gnc_fmaq). Both would be cleared quickly as that TX is
1162 * sent. Now the gnc_state == CLOSED, so we hit
1163 * kgnilnd_complete_closed_conn. At this point, nobody can 'find' this conn
1164 * - we've nuked them from the peer and CQ id tables, so we own them and
1165 * are guaranteed serial access - hence the complete lack of conn list
1166 * locking in kgnilnd_complete_closed_conn. We are free then to mark the
1167 * conn DESTROY_EP (add #6 for schedule_conn), then lose #5 in
1168 * kgnilnd_process_conns. Then the next scheduler loop would call
1169 * kgnilnd_destroy_conn_ep (drop #2 for EP) and lose #6 (refcount=0) in
1170 * kgnilnd_process_conns.
1172 * Clearly, we are totally safe. Clearly.
1175 #define kgnilnd_conn_decref(conn) \
1180 val = atomic_dec_return(&conn->gnc_refcount); \
1181 LASSERTF(val >= 0, "conn %p refc %d to %s\n", \
1184 ? libcfs_nid2str(conn->gnc_peer->gnp_nid) \
1186 CDEBUG(D_NETTRACE, "conn %p->%s-- (%d)\n", conn, \
1188 ? libcfs_nid2str(conn->gnc_peer->gnp_nid) \
1193 (conn->gnc_ephandle != NULL) && \
1194 (conn->gnc_state != GNILND_CONN_DESTROY_EP)) { \
1195 set_mb(conn->gnc_state, GNILND_CONN_DESTROY_EP); \
1196 kgnilnd_schedule_conn(conn); \
1197 } else if (val == 0) { \
1198 kgnilnd_destroy_conn(conn); \
1202 static inline struct list_head *
1203 kgnilnd_nid2peerlist(lnet_nid_t nid)
1205 unsigned int hash = ((unsigned int)LNET_NIDADDR(nid)) % *kgnilnd_tunables.kgn_peer_hash_size;
1207 RETURN(&kgnilnd_data.kgn_peers[hash]);
1210 static inline struct list_head *
1211 kgnilnd_netnum2netlist(__u16 netnum)
1213 unsigned int hash = ((unsigned int) netnum) % *kgnilnd_tunables.kgn_net_hash_size;
1215 RETURN(&kgnilnd_data.kgn_nets[hash]);
1219 kgnilnd_peer_active(kgn_peer_t *peer)
1221 /* Am I in the peer hash table? */
1222 return (!list_empty(&peer->gnp_list));
1225 /* need write_lock on kgn_peer_conn_lock */
1227 kgnilnd_can_unlink_peer_locked(kgn_peer_t *peer)
1229 CDEBUG(D_NET, "peer 0x%p->%s conns? %d tx? %d\n",
1230 peer, libcfs_nid2str(peer->gnp_nid),
1231 !list_empty(&peer->gnp_conns),
1232 !list_empty(&peer->gnp_tx_queue));
1234 /* kgn_peer_conn_lock protects us from conflict with
1235 * kgnilnd_peer_notify and gnp_persistent */
1236 RETURN ((list_empty(&peer->gnp_conns)) &&
1237 (list_empty(&peer->gnp_tx_queue)));
1240 /* returns positive if error was for a clean shutdown of conn */
1242 kgnilnd_conn_clean_errno(int errno)
1244 /* - ESHUTDOWN - LND is unloading
1245 * - EUCLEAN - admin requested via "lctl del_peer"
1246 * - ENETRESET - admin requested via "lctl disconnect" or rca event
1247 * - ENOTRECOVERABLE - stack reset
1248 * - EISCONN - cleared via "lctl push"
1249 * not doing ESTALE - that isn't clean */
1250 RETURN ((errno == 0) ||
1251 (errno == -ESHUTDOWN) ||
1252 (errno == -EUCLEAN) ||
1253 (errno == -ENETRESET) ||
1254 (errno == -EISCONN) ||
1255 (errno == -ENOTRECOVERABLE));
1258 /* returns positive if error results in purgatory hold */
1260 kgnilnd_check_purgatory_errno(int errno)
1262 /* We don't want to save the purgatory lists these cases:
1263 * - EUCLEAN - admin requested via "lctl del_peer"
1264 * - ESHUTDOWN - LND is unloading
1266 RETURN ((errno != -ESHUTDOWN) &&
1267 (errno != -EUCLEAN));
1271 /* returns positive if a purgatory hold is needed */
1273 kgnilnd_check_purgatory_conn(kgn_conn_t *conn)
1277 if (conn->gnc_peer) {
1278 loopback = conn->gnc_peer->gnp_nid ==
1279 conn->gnc_peer->gnp_net->gnn_ni->ni_nid;
1281 /* short circuit - a conn that didn't complete
1282 * setup never needs a purgatory hold */
1285 CDEBUG(D_NETTRACE, "conn 0x%p->%s loopback %d close_recvd %d\n",
1286 conn, conn->gnc_peer ?
1287 libcfs_nid2str(conn->gnc_peer->gnp_nid) :
1289 loopback, conn->gnc_close_recvd);
1291 /* we only use a purgatory hold if we've not received the CLOSE msg
1292 * from our peer - without that message, we can't know the state of
1293 * the other end of this connection and must put it into purgatory
1294 * to prevent reuse and corruption.
1295 * The theory is that a TX error can be communicated in all other cases
1297 RETURN(likely(!loopback) && !conn->gnc_close_recvd &&
1298 kgnilnd_check_purgatory_errno(conn->gnc_error));
1301 static inline const char *
1302 kgnilnd_tx_state2str(kgn_tx_list_state_t state);
1304 static inline struct list_head *
1305 kgnilnd_tx_state2list(kgn_peer_t *peer, kgn_conn_t *conn,
1306 kgn_tx_list_state_t to_state)
1309 case GNILND_TX_PEERQ:
1310 return &peer->gnp_tx_queue;
1311 case GNILND_TX_FMAQ:
1312 return &conn->gnc_fmaq;
1313 case GNILND_TX_LIVE_FMAQ:
1314 case GNILND_TX_LIVE_RDMAQ:
1315 case GNILND_TX_DYING:
1317 case GNILND_TX_MAPQ:
1318 return &conn->gnc_device->gnd_map_tx;
1319 case GNILND_TX_RDMAQ:
1320 return &conn->gnc_device->gnd_rdmaq;
1322 /* IDLE, FREED or ALLOCD is not valid "on list" state */
1323 CERROR("invalid state requested: %s\n",
1324 kgnilnd_tx_state2str(to_state));
1330 /* should hold tx, conn or peer lock when calling */
1332 kgnilnd_tx_add_state_locked(kgn_tx_t *tx, kgn_peer_t *peer,
1333 kgn_conn_t *conn, kgn_tx_list_state_t state,
1336 struct list_head *list = NULL;
1338 /* make sure we have a sane TX state to start */
1339 GNITX_ASSERTF(tx, (tx->tx_list_p == NULL &&
1340 tx->tx_list_state == GNILND_TX_ALLOCD) &&
1341 list_empty(&tx->tx_list),
1342 "bad state with tx_list %s",
1343 list_empty(&tx->tx_list) ? "empty" : "not empty");
1345 /* WTF - you are already on that state buttmunch */
1346 GNITX_ASSERTF(tx, state != tx->tx_list_state,
1347 "already at %s", kgnilnd_tx_state2str(state));
1349 /* get proper list from the state requested */
1350 list = kgnilnd_tx_state2list(peer, conn, state);
1354 case GNILND_TX_PEERQ:
1355 kgnilnd_peer_addref(peer);
1357 case GNILND_TX_ALLOCD:
1358 /* no refs needed */
1360 case GNILND_TX_FMAQ:
1361 kgnilnd_conn_addref(conn);
1363 case GNILND_TX_MAPQ:
1364 atomic_inc(&conn->gnc_device->gnd_nq_map);
1365 kgnilnd_conn_addref(conn);
1367 case GNILND_TX_LIVE_FMAQ:
1368 atomic_inc(&conn->gnc_nlive_fma);
1369 kgnilnd_conn_addref(conn);
1371 case GNILND_TX_LIVE_RDMAQ:
1372 atomic_inc(&conn->gnc_nlive_rdma);
1373 kgnilnd_conn_addref(conn);
1375 case GNILND_TX_RDMAQ:
1376 atomic_inc(&conn->gnc_nq_rdma);
1377 kgnilnd_conn_addref(conn);
1379 case GNILND_TX_DYING:
1380 kgnilnd_conn_addref(conn);
1383 CERROR("invalid state requested: %s\n",
1384 kgnilnd_tx_state2str(state));
1389 /* if this changes, change kgnilnd_alloc_tx */
1390 tx->tx_list_state = state;
1392 /* some states don't have lists - we track them in the per conn
1393 * TX table instead. Waste not, want not! */
1395 tx->tx_list_p = list;
1397 list_add_tail(&tx->tx_list, list);
1399 list_add(&tx->tx_list, list);
1401 /* set dummy list_p to make book keeping happy and let debugging
1402 * be a hair easier */
1403 tx->tx_list_p = (void *)state;
1406 GNIDBG_TX(D_NET, tx, "onto %s->0x%p",
1407 kgnilnd_tx_state2str(state), list);
1411 kgnilnd_tx_del_state_locked(kgn_tx_t *tx, kgn_peer_t *peer,
1412 kgn_conn_t *conn, kgn_tx_list_state_t new_state)
1414 /* These is only 1 "off-list" state */
1415 GNITX_ASSERTF(tx, new_state == GNILND_TX_ALLOCD,
1416 "invalid new_state %s", kgnilnd_tx_state2str(new_state));
1418 /* new_state == ALLOCD means we are deallocating this tx,
1419 * so make sure it was on a valid list to start with */
1420 GNITX_ASSERTF(tx, (tx->tx_list_p != NULL) &&
1421 (((tx->tx_list_state == GNILND_TX_LIVE_FMAQ) ||
1422 (tx->tx_list_state == GNILND_TX_LIVE_RDMAQ) ||
1423 (tx->tx_list_state == GNILND_TX_DYING)) == list_empty(&tx->tx_list)),
1426 GNIDBG_TX(D_NET, tx, "off %p", tx->tx_list_p);
1429 switch (tx->tx_list_state) {
1430 case GNILND_TX_PEERQ:
1431 kgnilnd_peer_decref(peer);
1433 case GNILND_TX_FREED:
1434 case GNILND_TX_IDLE:
1435 case GNILND_TX_ALLOCD:
1436 /* no refs needed */
1438 case GNILND_TX_DYING:
1439 kgnilnd_conn_decref(conn);
1441 case GNILND_TX_FMAQ:
1442 kgnilnd_conn_decref(conn);
1444 case GNILND_TX_MAPQ:
1445 atomic_dec(&conn->gnc_device->gnd_nq_map);
1446 kgnilnd_conn_decref(conn);
1448 case GNILND_TX_LIVE_FMAQ:
1449 atomic_dec(&conn->gnc_nlive_fma);
1450 kgnilnd_conn_decref(conn);
1452 case GNILND_TX_LIVE_RDMAQ:
1453 atomic_dec(&conn->gnc_nlive_rdma);
1454 kgnilnd_conn_decref(conn);
1456 case GNILND_TX_RDMAQ:
1457 atomic_dec(&conn->gnc_nq_rdma);
1458 kgnilnd_conn_decref(conn);
1459 /* don't need to assert on default, already did in set */
1462 /* for ALLOCD, this might already be true, but no harm doing it again */
1463 list_del_init(&tx->tx_list);
1464 tx->tx_list_p = NULL;
1465 tx->tx_list_state = new_state;
1469 kgnilnd_tx_mapped(kgn_tx_t *tx)
1471 return (tx->tx_buftype == GNILND_BUF_VIRT_MAPPED ||
1472 tx->tx_buftype == GNILND_BUF_PHYS_MAPPED);
1475 static inline struct list_head *
1476 kgnilnd_cqid2connlist(__u32 cqid)
1478 unsigned int hash = cqid % *kgnilnd_tunables.kgn_peer_hash_size;
1480 return (&kgnilnd_data.kgn_conns [hash]);
1483 static inline kgn_conn_t *
1484 kgnilnd_cqid2conn_locked(__u32 cqid)
1486 struct list_head *conns = kgnilnd_cqid2connlist(cqid);
1487 struct list_head *tmp;
1490 list_for_each(tmp, conns) {
1491 conn = list_entry(tmp, kgn_conn_t, gnc_hashlist);
1493 if (conn->gnc_cqid == cqid)
1500 /* returns 1..GNILND_MAX_CQID on success, 0 on failure */
1502 kgnilnd_get_cqid_locked(void)
1508 cqid = kgnilnd_data.kgn_next_cqid++;
1509 if (kgnilnd_data.kgn_next_cqid >= GNILND_MAX_CQID) {
1513 kgnilnd_data.kgn_next_cqid = 1;
1516 } while (kgnilnd_cqid2conn_locked(cqid) != NULL);
1522 kgnilnd_validate_tx_ev_id(kgn_tx_ev_id_t *ev_id, kgn_tx_t **txp, kgn_conn_t **connp)
1524 kgn_tx_t *tx = NULL;
1525 kgn_conn_t *conn = NULL;
1527 /* set to NULL so any early return is an error */
1531 LASSERTF((ev_id->txe_idx > 0) &&
1532 (ev_id->txe_idx < GNILND_MAX_MSG_ID),
1533 "bogus txe_idx %d >= %d\n",
1534 ev_id->txe_idx, GNILND_MAX_MSG_ID);
1536 LASSERTF((ev_id->txe_cqid > 0) &&
1537 (ev_id->txe_cqid < GNILND_MAX_CQID),
1538 "bogus txe_cqid %d >= %d\n",
1539 ev_id->txe_cqid, GNILND_MAX_CQID);
1541 read_lock(&kgnilnd_data.kgn_peer_conn_lock);
1542 conn = kgnilnd_cqid2conn_locked(ev_id->txe_cqid);
1545 /* Conn was destroyed? */
1546 read_unlock(&kgnilnd_data.kgn_peer_conn_lock);
1547 CDEBUG(D_NET, "CQID %d lookup failed\n", ev_id->txe_cqid);
1550 /* just insurance */
1551 kgnilnd_conn_addref(conn);
1552 kgnilnd_admin_addref(conn->gnc_tx_in_use);
1553 read_unlock(&kgnilnd_data.kgn_peer_conn_lock);
1555 /* we know this is safe - as the TX won't be reused until AFTER
1556 * the conn is unlinked from the cqid hash, so we can use the TX
1557 * (serializing to avoid any cache oddness) freely from the conn tx ref table */
1559 spin_lock(&conn->gnc_tx_lock);
1560 tx = conn->gnc_tx_ref_table[ev_id->txe_idx];
1561 spin_unlock(&conn->gnc_tx_lock);
1563 /* We could have a tx that was cleared out by other forces
1564 * lctl disconnect or del_peer. */
1566 CNETERR("txe_idx %d is gone, ignoring event\n", ev_id->txe_idx);
1567 kgnilnd_admin_decref(conn->gnc_tx_in_use);
1568 kgnilnd_conn_decref(conn);
1572 /* check tx->tx_msg magic to make sure kgni didn't eat it */
1573 GNITX_ASSERTF(tx, tx->tx_msg.gnm_magic == GNILND_MSG_MAGIC,
1574 "came back from kgni with bad magic %x", tx->tx_msg.gnm_magic);
1576 GNITX_ASSERTF(tx, tx->tx_id.txe_idx == ev_id->txe_idx,
1577 "conn 0x%p->%s tx_ref_table hosed: wanted txe_idx %d "
1578 "found tx %p txe_idx %d",
1579 conn, libcfs_nid2str(conn->gnc_peer->gnp_nid),
1580 ev_id->txe_idx, tx, tx->tx_id.txe_idx);
1582 GNITX_ASSERTF(tx, tx->tx_conn != NULL, "tx with NULL connection", NULL);
1584 GNITX_ASSERTF(tx, tx->tx_conn == conn, "tx conn does not equal conn", NULL);
1589 GNIDBG_TX(D_NET, tx, "validated to 0x%p", conn);
1592 /* set_normalized_timepsec isn't exported from the kernel, so
1593 * we need to do the same thing inline */
1594 static inline struct timespec
1595 kgnilnd_ts_sub(struct timespec lhs, struct timespec rhs)
1601 sec = lhs.tv_sec - rhs.tv_sec;
1602 nsec = lhs.tv_nsec - rhs.tv_nsec;
1604 while (nsec >= NSEC_PER_SEC) {
1605 nsec -= NSEC_PER_SEC;
1609 nsec += NSEC_PER_SEC;
1618 kgnilnd_count_list(struct list_head *q)
1620 struct list_head *e;
1623 list_for_each(e, q) {
1630 /* kgnilnd_find_net adds a reference to the net it finds
1631 * this is so the net will not be removed before the calling function
1632 * has time to use the data returned. This reference needs to be released
1633 * by the calling function once it has finished using the returned net
1637 kgnilnd_find_net(lnet_nid_t nid, kgn_net_t **netp)
1642 rc = down_read_trylock(&kgnilnd_data.kgn_net_rw_sem);
1648 list_for_each_entry(net, kgnilnd_netnum2netlist(LNET_NETNUM(LNET_NIDNET(nid))), gnn_list) {
1649 if (!net->gnn_shutdown && LNET_NIDNET(net->gnn_ni->ni_nid) == LNET_NIDNET(nid)) {
1650 kgnilnd_net_addref(net);
1651 up_read(&kgnilnd_data.kgn_net_rw_sem);
1657 up_read(&kgnilnd_data.kgn_net_rw_sem);
1662 #ifdef CONFIG_DEBUG_SLAB
1663 #define KGNILND_POISON(ptr, c, s) do {} while(0)
1665 #define KGNILND_POISON(ptr, c, s) memset(ptr, c, s)
1668 int kgnilnd_dev_init(kgn_device_t *dev);
1669 void kgnilnd_dev_fini(kgn_device_t *dev);
1670 int kgnilnd_startup(lnet_ni_t *ni);
1671 void kgnilnd_shutdown(lnet_ni_t *ni);
1672 int kgnilnd_base_startup(void);
1673 void kgnilnd_base_shutdown(void);
1675 int kgnilnd_allocate_phys_fmablk(kgn_device_t *device);
1676 int kgnilnd_map_phys_fmablk(kgn_device_t *device);
1677 void kgnilnd_unmap_fma_blocks(kgn_device_t *device);
1678 void kgnilnd_free_phys_fmablk(kgn_device_t *device);
1680 int kgnilnd_ctl(lnet_ni_t *ni, unsigned int cmd, void *arg);
1681 void kgnilnd_query(lnet_ni_t *ni, lnet_nid_t nid, cfs_time_t *when);
1682 int kgnilnd_send(lnet_ni_t *ni, void *private, lnet_msg_t *lntmsg);
1683 int kgnilnd_eager_recv(lnet_ni_t *ni, void *private,
1684 lnet_msg_t *lntmsg, void **new_private);
1685 int kgnilnd_recv(lnet_ni_t *ni, void *private, lnet_msg_t *lntmsg,
1686 int delayed, unsigned int niov,
1687 struct iovec *iov, lnet_kiov_t *kiov,
1688 unsigned int offset, unsigned int mlen, unsigned int rlen);
1690 __u16 kgnilnd_cksum_kiov(unsigned int nkiov, lnet_kiov_t *kiov, unsigned int offset, unsigned int nob, int dump_blob);
1692 /* purgatory functions */
1693 void kgnilnd_add_purgatory_locked(kgn_conn_t *conn, kgn_peer_t *peer);
1694 void kgnilnd_mark_for_detach_purgatory_all_locked(kgn_peer_t *peer);
1695 void kgnilnd_detach_purgatory_locked(kgn_conn_t *conn, struct list_head *conn_list);
1696 void kgnilnd_release_purgatory_list(struct list_head *conn_list);
1698 void kgnilnd_update_reaper_timeout(long timeout);
1699 void kgnilnd_unmap_buffer(kgn_tx_t *tx, int error);
1700 kgn_tx_t *kgnilnd_new_tx_msg(int type, lnet_nid_t source);
1701 void kgnilnd_tx_done(kgn_tx_t *tx, int completion);
1702 void kgnilnd_txlist_done(struct list_head *txlist, int error);
1703 void kgnilnd_unlink_peer_locked(kgn_peer_t *peer);
1704 int _kgnilnd_schedule_conn(kgn_conn_t *conn, const char *caller, int line, int refheld);
1705 int kgnilnd_schedule_process_conn(kgn_conn_t *conn, int sched_intent);
1707 void kgnilnd_schedule_dgram(kgn_device_t *dev);
1708 int kgnilnd_create_peer_safe(kgn_peer_t **peerp, lnet_nid_t nid, kgn_net_t *net, int node_state);
1709 void kgnilnd_add_peer_locked(lnet_nid_t nid, kgn_peer_t *new_stub_peer, kgn_peer_t **peerp);
1710 int kgnilnd_add_peer(kgn_net_t *net, lnet_nid_t nid, kgn_peer_t **peerp);
1712 kgn_peer_t *kgnilnd_find_peer_locked(lnet_nid_t nid);
1713 int kgnilnd_del_conn_or_peer(kgn_net_t *net, lnet_nid_t nid, int command, int error);
1714 void kgnilnd_peer_increase_reconnect_locked(kgn_peer_t *peer);
1715 void kgnilnd_queue_reply(kgn_conn_t *conn, kgn_tx_t *tx);
1716 void kgnilnd_queue_tx(kgn_conn_t *conn, kgn_tx_t *tx);
1717 void kgnilnd_launch_tx(kgn_tx_t *tx, kgn_net_t *net, lnet_process_id_t *target);
1718 int kgnilnd_send_mapped_tx(kgn_tx_t *tx, int try_map_if_full);
1719 void kgnilnd_consume_rx(kgn_rx_t *rx);
1721 void kgnilnd_schedule_device(kgn_device_t *dev);
1722 void kgnilnd_device_callback(__u32 devid, __u64 arg);
1723 void kgnilnd_schedule_device_timer(unsigned long arg);
1725 int kgnilnd_reaper(void *arg);
1726 int kgnilnd_scheduler(void *arg);
1727 int kgnilnd_dgram_mover(void *arg);
1728 int kgnilnd_rca(void *arg);
1730 int kgnilnd_create_conn(kgn_conn_t **connp, kgn_device_t *dev);
1731 int kgnilnd_conn_isdup_locked(kgn_peer_t *peer, kgn_conn_t *newconn);
1732 kgn_conn_t *kgnilnd_find_conn_locked(kgn_peer_t *peer);
1733 int kgnilnd_get_conn(kgn_conn_t **connp, kgn_peer_t);
1734 kgn_conn_t *kgnilnd_find_or_create_conn_locked(kgn_peer_t *peer);
1735 void kgnilnd_peer_cancel_tx_queue(kgn_peer_t *peer);
1736 void kgnilnd_cancel_peer_connect_locked(kgn_peer_t *peer, struct list_head *zombies);
1737 int kgnilnd_close_stale_conns_locked(kgn_peer_t *peer, kgn_conn_t *newconn);
1738 void kgnilnd_peer_alive(kgn_peer_t *peer);
1739 void kgnilnd_peer_notify(kgn_peer_t *peer, int error);
1740 void kgnilnd_close_conn_locked(kgn_conn_t *conn, int error);
1741 void kgnilnd_close_conn(kgn_conn_t *conn, int error);
1742 void kgnilnd_complete_closed_conn(kgn_conn_t *conn);
1743 void kgnilnd_destroy_conn_ep(kgn_conn_t *conn);
1745 int kgnilnd_close_peer_conns_locked(kgn_peer_t *peer, int why);
1746 int kgnilnd_report_node_state(lnet_nid_t nid, int down);
1747 void kgnilnd_wakeup_rca_thread(void);
1748 int kgnilnd_start_rca_thread(void);
1749 int kgnilnd_get_node_state(__u32 nid);
1751 int kgnilnd_tunables_init(void);
1752 void kgnilnd_tunables_fini(void);
1753 void kgnilnd_init_msg(kgn_msg_t *msg, int type, lnet_nid_t source);
1755 void kgnilnd_bump_timeouts(__u32 nap_time, char *reason);
1756 void kgnilnd_pause_threads(void);
1757 int kgnilnd_hw_in_quiesce(void);
1758 int kgnilnd_check_hw_quiesce(void);
1759 void kgnilnd_quiesce_wait(char *reason);
1760 void kgnilnd_quiesce_end_callback(gni_nic_handle_t nic_handle, uint64_t msecs);
1761 int kgnilnd_ruhroh_thread(void *arg);
1762 void kgnilnd_reset_stack(void);
1763 void kgnilnd_critical_error(gni_err_handle_t err_handle);
1765 void kgnilnd_insert_sysctl(void);
1766 void kgnilnd_remove_sysctl(void);
1767 void kgnilnd_proc_init(void);
1768 void kgnilnd_proc_fini(void);
1771 void kgnilnd_release_mbox(kgn_conn_t *conn, int purgatory_hold);
1773 int kgnilnd_find_and_cancel_dgram(kgn_device_t *dev, lnet_nid_t dst_nid);
1774 void kgnilnd_cancel_dgram_locked(kgn_dgram_t *dgram);
1775 void kgnilnd_release_dgram(kgn_device_t *dev, kgn_dgram_t *dgram, int shutdown);
1777 int kgnilnd_setup_wildcard_dgram(kgn_device_t *dev);
1778 int kgnilnd_cancel_net_dgrams(kgn_net_t *net);
1779 int kgnilnd_cancel_wc_dgrams(kgn_device_t *dev);
1780 int kgnilnd_cancel_dgrams(kgn_device_t *dev);
1781 void kgnilnd_wait_for_canceled_dgrams(kgn_device_t *dev);
1783 int kgnilnd_dgram_waitq(void *arg);
1785 int kgnilnd_set_conn_params(kgn_dgram_t *dgram);
1787 /* struct2str functions - we don't use a default: case to cause the compile
1788 * to fail if there is a missing case. This allows us to hide these down here
1789 * out of the way but ensure we'll catch any updates to the enum/types
1792 #define DO_TYPE(x) case x: return #x;
1793 static inline const char *
1794 kgnilnd_fmablk_state2str(kgn_fmablk_state_t state)
1796 /* Only want single char string for this */
1798 case GNILND_FMABLK_IDLE:
1800 case GNILND_FMABLK_PHYS:
1802 case GNILND_FMABLK_VIRT:
1804 case GNILND_FMABLK_FREED:
1807 return "<unknown state>";
1810 static inline const char *
1811 kgnilnd_msgtype2str(int type)
1814 DO_TYPE(GNILND_MSG_NONE);
1815 DO_TYPE(GNILND_MSG_NOOP);
1816 DO_TYPE(GNILND_MSG_IMMEDIATE);
1817 DO_TYPE(GNILND_MSG_PUT_REQ);
1818 DO_TYPE(GNILND_MSG_PUT_NAK);
1819 DO_TYPE(GNILND_MSG_PUT_ACK);
1820 DO_TYPE(GNILND_MSG_PUT_DONE);
1821 DO_TYPE(GNILND_MSG_GET_REQ);
1822 DO_TYPE(GNILND_MSG_GET_NAK);
1823 DO_TYPE(GNILND_MSG_GET_DONE);
1824 DO_TYPE(GNILND_MSG_CLOSE);
1825 DO_TYPE(GNILND_MSG_PUT_REQ_REV);
1826 DO_TYPE(GNILND_MSG_PUT_DONE_REV);
1827 DO_TYPE(GNILND_MSG_PUT_NAK_REV);
1828 DO_TYPE(GNILND_MSG_GET_REQ_REV);
1829 DO_TYPE(GNILND_MSG_GET_ACK_REV);
1830 DO_TYPE(GNILND_MSG_GET_DONE_REV);
1831 DO_TYPE(GNILND_MSG_GET_NAK_REV);
1833 return "<unknown msg type>";
1836 static inline const char *
1837 kgnilnd_tx_state2str(kgn_tx_list_state_t state)
1840 DO_TYPE(GNILND_TX_IDLE);
1841 DO_TYPE(GNILND_TX_ALLOCD);
1842 DO_TYPE(GNILND_TX_PEERQ);
1843 DO_TYPE(GNILND_TX_MAPQ);
1844 DO_TYPE(GNILND_TX_FMAQ);
1845 DO_TYPE(GNILND_TX_LIVE_FMAQ);
1846 DO_TYPE(GNILND_TX_RDMAQ);
1847 DO_TYPE(GNILND_TX_LIVE_RDMAQ);
1848 DO_TYPE(GNILND_TX_DYING);
1849 DO_TYPE(GNILND_TX_FREED);
1851 return "<unknown state>";
1854 static inline const char *
1855 kgnilnd_conn_state2str(kgn_conn_t *conn)
1857 kgn_conn_state_t state = conn->gnc_state;
1859 DO_TYPE(GNILND_CONN_DUMMY);
1860 DO_TYPE(GNILND_CONN_LISTEN);
1861 DO_TYPE(GNILND_CONN_CONNECTING);
1862 DO_TYPE(GNILND_CONN_ESTABLISHED);
1863 DO_TYPE(GNILND_CONN_CLOSING);
1864 DO_TYPE(GNILND_CONN_CLOSED);
1865 DO_TYPE(GNILND_CONN_DONE);
1866 DO_TYPE(GNILND_CONN_DESTROY_EP);
1871 static inline const char *
1872 kgnilnd_connreq_type2str(kgn_connreq_t *connreq)
1874 kgn_connreq_type_t type = connreq->gncr_type;
1877 DO_TYPE(GNILND_CONNREQ_REQ);
1878 DO_TYPE(GNILND_CONNREQ_NAK);
1879 DO_TYPE(GNILND_CONNREQ_CLOSE);
1884 static inline const char *
1885 kgnilnd_dgram_state2str(kgn_dgram_t *dgram)
1887 kgn_dgram_state_t state = dgram->gndg_state;
1890 DO_TYPE(GNILND_DGRAM_USED);
1891 DO_TYPE(GNILND_DGRAM_POSTING);
1892 DO_TYPE(GNILND_DGRAM_POSTED);
1893 DO_TYPE(GNILND_DGRAM_PROCESSING);
1894 DO_TYPE(GNILND_DGRAM_DONE);
1895 DO_TYPE(GNILND_DGRAM_CANCELED);
1900 static inline const char *
1901 kgnilnd_dgram_type2str(kgn_dgram_t *dgram)
1903 kgn_dgram_type_t type = dgram->gndg_type;
1906 DO_TYPE(GNILND_DGRAM_REQ);
1907 DO_TYPE(GNILND_DGRAM_WC_REQ);
1908 DO_TYPE(GNILND_DGRAM_NAK);
1909 DO_TYPE(GNILND_DGRAM_CLOSE);
1914 static inline const char *
1915 kgnilnd_conn_dgram_type2str(kgn_dgram_type_t type)
1918 DO_TYPE(GNILND_DGRAM_REQ);
1919 DO_TYPE(GNILND_DGRAM_WC_REQ);
1920 DO_TYPE(GNILND_DGRAM_NAK);
1921 DO_TYPE(GNILND_DGRAM_CLOSE);
1928 /* API wrapper functions - include late to pick up all of the other defines */
1929 #include "gnilnd_api_wrap.h"
1931 /* pulls in tunables per platform and adds in nid/nic conversion
1932 * if RCA wasn't available at build time */
1933 #include "gnilnd_hss_ops.h"
1935 #if defined(CONFIG_CRAY_GEMINI)
1936 #include "gnilnd_gemini.h"
1937 #elif defined(CONFIG_CRAY_ARIES)
1938 #include "gnilnd_aries.h"
1940 #error "Undefined Network Hardware Type"
1943 #endif /* _GNILND_GNILND_H_ */