Whamcloud - gitweb
* Made openib not use the subnet manager to discover connection parameters
[fs/lustre-release.git] / lnet / klnds / ralnd / ralnd.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * Copyright (C) 2004 Cluster File Systems, Inc.
5  *   Author: Eric Barton <eric@bartonsoftware.com>
6  *
7  *   This file is part of Lustre, http://www.lustre.org.
8  *
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.
12  *
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.
17  *
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.
21  *
22  */
23
24 #ifndef EXPORT_SYMTAB
25 # define EXPORT_SYMTAB
26 #endif
27
28 #include <linux/config.h>
29 #include <linux/module.h>
30 #include <linux/kernel.h>
31 #include <linux/mm.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>
38
39 #include <asm/system.h>
40 #include <asm/uaccess.h>
41 #include <asm/io.h>
42
43 #include <linux/init.h>
44 #include <linux/fs.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>
50
51 #include <net/sock.h>
52
53 #define DEBUG_SUBSYSTEM S_NAL
54
55 #include <linux/kp30.h>
56 #include <portals/p30.h>
57 #include <portals/lib-p30.h>
58 #include <portals/nal.h>
59
60 #include <rapl.h>
61
62 #define RANAL_MAXDEVS       2                   /* max # devices RapidArray supports */
63
64 #define RANAL_N_CONND       4                   /* # connection daemons */
65
66 #define RANAL_MIN_RECONNECT_INTERVAL 1          /* first failed connection retry (seconds)... */
67 #define RANAL_MAX_RECONNECT_INTERVAL 60         /* ...exponentially increasing to this */
68
69 #define RANAL_FMA_MAX_PREFIX      232           /* max size of FMA "Prefix" */
70 #define RANAL_FMA_MAX_DATA        ((7<<10)-256) /* Max FMA MSG is 7K including prefix */
71
72 #define RANAL_PEER_HASH_SIZE  101               /* # peer lists */
73 #define RANAL_CONN_HASH_SIZE  101               /* # conn lists */
74
75 #define RANAL_NTX             64                /* # tx descs */
76 #define RANAL_NTX_NBLK        256               /* # reserved tx descs */
77
78 #define RANAL_FMA_CQ_SIZE     8192              /* # entries in receive CQ 
79                                                  * (overflow is a performance hit) */
80
81 #define RANAL_RESCHED         100               /* # scheduler loops before reschedule */
82
83 #define RANAL_MIN_TIMEOUT     5                 /* minimum timeout interval (seconds) */
84 #define RANAL_TIMEOUT2KEEPALIVE(t) (((t)+1)/2)  /* timeout -> keepalive interval */
85
86 /* default vals for runtime tunables */
87 #define RANAL_TIMEOUT           30              /* comms timeout (seconds) */
88 #define RANAL_LISTENER_TIMEOUT   5              /* listener timeout (seconds) */
89 #define RANAL_BACKLOG          127              /* listener's backlog */
90 #define RANAL_PORT             988              /* listener's port */
91 #define RANAL_MAX_IMMEDIATE    (2<<10)          /* immediate payload breakpoint */
92
93 typedef struct 
94 {
95         int               kra_timeout;          /* comms timeout (seconds) */
96         int               kra_listener_timeout; /* max time the listener can block */
97         int               kra_backlog;          /* listener's backlog */
98         int               kra_port;             /* listener's TCP/IP port */
99         int               kra_max_immediate;    /* immediate payload breakpoint */
100
101         struct ctl_table_header *kra_sysctl;    /* sysctl interface */
102 } kra_tunables_t;
103
104 typedef struct
105 {
106         RAP_PVOID               rad_handle;     /* device handle */
107         RAP_PVOID               rad_fma_cqh;    /* FMA completion queue handle */
108         RAP_PVOID               rad_rdma_cqh;   /* rdma completion queue handle */
109         int                     rad_id;         /* device id */
110         int                     rad_idx;        /* index in kra_devices */
111         int                     rad_ready;      /* set by device callback */
112         struct list_head        rad_connq;      /* connections requiring attention */
113         struct list_head        rad_zombies;    /* connections to free */
114         wait_queue_head_t       rad_waitq;      /* scheduler waits here */
115         spinlock_t              rad_lock;       /* serialise */
116         void                   *rad_scheduler;  /* scheduling thread */
117 } kra_device_t;
118         
119 typedef struct 
120 {
121         int               kra_init;             /* initialisation state */
122         int               kra_shutdown;         /* shut down? */
123         atomic_t          kra_nthreads;         /* # live threads */
124
125         struct semaphore  kra_nid_mutex;        /* serialise NID/listener ops */
126         struct semaphore  kra_listener_signal;  /* block for listener startup/shutdown */
127         struct socket    *kra_listener_sock;    /* listener's socket */
128         int               kra_listener_shutdown; /* ask listener to close */
129
130         kra_device_t      kra_devices[RANAL_MAXDEVS]; /* device/ptag/cq etc */
131         int               kra_ndevs;            /* # devices */
132
133         rwlock_t          kra_global_lock;      /* stabilize peer/conn ops */
134
135         struct list_head *kra_peers;            /* hash table of all my known peers */
136         int               kra_peer_hash_size;   /* size of kra_peers */
137         atomic_t          kra_npeers;           /* # peers extant */
138
139         struct list_head *kra_conns;            /* conns hashed by cqid */
140         int               kra_conn_hash_size;   /* size of kra_conns */
141         __u64             kra_peerstamp;        /* when I started up */
142         __u64             kra_connstamp;        /* conn stamp generator */
143         int               kra_next_cqid;        /* cqid generator */
144         atomic_t          kra_nconns;           /* # connections extant */
145
146         long              kra_new_min_timeout;  /* minimum timeout on any new conn */
147         wait_queue_head_t kra_reaper_waitq;     /* reaper sleeps here */
148         spinlock_t        kra_reaper_lock;      /* serialise */
149         
150         struct list_head  kra_connd_peers;      /* peers waiting for a connection */
151         struct list_head  kra_connd_acceptq;    /* accepted sockets to handshake */
152         wait_queue_head_t kra_connd_waitq;      /* connection daemons sleep here */
153         spinlock_t        kra_connd_lock;       /* serialise */
154
155         struct list_head  kra_idle_txs;         /* idle tx descriptors */
156         struct list_head  kra_idle_nblk_txs;    /* idle reserved tx descriptors */
157         __u64             kra_next_tx_cookie;   /* RDMA completion cookie */
158         wait_queue_head_t kra_idle_tx_waitq;    /* block here for tx descriptor */
159         spinlock_t        kra_tx_lock;          /* serialise */
160 } kra_data_t;
161
162 #define RANAL_INIT_NOTHING         0
163 #define RANAL_INIT_DATA            1
164 #define RANAL_INIT_LIB             2
165 #define RANAL_INIT_ALL             3
166
167 typedef struct kra_acceptsock                   /* accepted socket queued for connd */
168 {
169         struct list_head     ras_list;          /* queue for attention */
170         struct socket       *ras_sock;          /* the accepted socket */
171 } kra_acceptsock_t;
172
173 /************************************************************************
174  * Wire message structs.  These are sent in sender's byte order
175  * (i.e. receiver checks magic and flips if required).
176  */
177
178 typedef struct kra_connreq                      /* connection request/response */
179 {                                               /* (sent via socket) */
180         __u32             racr_magic;           /* I'm an ranal connreq */
181         __u16             racr_version;         /* this is my version number */
182         __u16             racr_devid;           /* sender's device ID */
183         __u64             racr_srcnid;          /* sender's NID */
184         __u64             racr_dstnid;          /* who sender expects to listen */
185         __u64             racr_peerstamp;       /* sender's instance stamp */
186         __u64             racr_connstamp;       /* sender's connection stamp */
187         __u32             racr_timeout;         /* sender's timeout */
188         RAP_RI_PARAMETERS racr_riparams;        /* sender's endpoint info */
189 } kra_connreq_t;
190
191 typedef struct
192 {
193         RAP_MEM_KEY       rard_key;
194         RAP_PVOID64       rard_addr;
195         RAP_UINT32        rard_nob;
196 } kra_rdma_desc_t;
197
198 typedef struct
199 {
200         ptl_hdr_t         raim_hdr;             /* portals header */
201         /* Portals payload is in FMA "Message Data" */
202 } kra_immediate_msg_t;
203
204 typedef struct
205 {
206         ptl_hdr_t         raprm_hdr;            /* portals header */
207         __u64             raprm_cookie;         /* opaque completion cookie */
208 } kra_putreq_msg_t;
209
210 typedef struct
211 {
212         __u64             rapam_src_cookie;     /* reflected completion cookie */
213         __u64             rapam_dst_cookie;     /* opaque completion cookie */
214         kra_rdma_desc_t   rapam_desc;           /* sender's sink buffer */
215 } kra_putack_msg_t;
216
217 typedef struct
218 {
219         ptl_hdr_t         ragm_hdr;             /* portals header */
220         __u64             ragm_cookie;          /* opaque completion cookie */
221         kra_rdma_desc_t   ragm_desc;            /* sender's sink buffer */
222 } kra_get_msg_t;
223
224 typedef struct
225 {
226         __u64             racm_cookie;          /* reflected completion cookie */
227 } kra_completion_msg_t;
228
229 typedef struct                                  /* NB must fit in FMA "Prefix" */
230 {
231         __u32             ram_magic;            /* I'm an ranal message */
232         __u16             ram_version;          /* this is my version number */
233         __u16             ram_type;             /* msg type */
234         __u64             ram_srcnid;           /* sender's NID */
235         __u64             ram_connstamp;        /* sender's connection stamp */
236         union {
237                 kra_immediate_msg_t   immediate;
238                 kra_putreq_msg_t      putreq;
239                 kra_putack_msg_t      putack;
240                 kra_get_msg_t         get;
241                 kra_completion_msg_t  completion;
242         }                    ram_u;
243         __u32             ram_seq;              /* incrementing sequence number */
244 } kra_msg_t;
245
246 #define RANAL_MSG_MAGIC       0x0be91b92        /* unique magic */
247 #define RANAL_MSG_VERSION              1        /* current protocol version */
248
249 #define RANAL_MSG_FENCE             0x80        /* fence RDMA */
250
251 #define RANAL_MSG_NONE              0x00        /* illegal message */
252 #define RANAL_MSG_NOOP              0x01        /* empty ram_u (keepalive) */
253 #define RANAL_MSG_IMMEDIATE         0x02        /* ram_u.immediate */
254 #define RANAL_MSG_PUT_REQ           0x03        /* ram_u.putreq (src->sink) */
255 #define RANAL_MSG_PUT_NAK           0x04        /* ram_u.completion (no PUT match: sink->src) */
256 #define RANAL_MSG_PUT_ACK           0x05        /* ram_u.putack (PUT matched: sink->src) */
257 #define RANAL_MSG_PUT_DONE          0x86        /* ram_u.completion (src->sink) */
258 #define RANAL_MSG_GET_REQ           0x07        /* ram_u.get (sink->src) */
259 #define RANAL_MSG_GET_NAK           0x08        /* ram_u.completion (no GET match: src->sink) */
260 #define RANAL_MSG_GET_DONE          0x89        /* ram_u.completion (src->sink) */
261 #define RANAL_MSG_CLOSE             0x8a        /* empty ram_u */
262
263 /***********************************************************************/
264
265 typedef struct kra_tx                           /* message descriptor */
266 {
267         struct list_head          tx_list;      /* queue on idle_txs/rac_sendq/rac_waitq */
268         struct kra_conn          *tx_conn;      /* owning conn */
269         lib_msg_t                *tx_libmsg[2]; /* lib msgs to finalize on completion */
270         unsigned long             tx_qtime;     /* when tx started to wait for something */
271         int                       tx_isnblk;    /* I'm reserved for non-blocking sends */
272         int                       tx_nob;       /* # bytes of payload */
273         int                       tx_buftype;   /* payload buffer type */
274         void                     *tx_buffer;    /* source/sink buffer */
275         int                       tx_phys_offset; /* first page offset (if phys) */
276         int                       tx_phys_npages; /* # physical pages */
277         RAP_PHYS_REGION          *tx_phys;      /* page descriptors */
278         RAP_MEM_KEY               tx_map_key;   /* mapping key */
279         RAP_RDMA_DESCRIPTOR       tx_rdma_desc; /* rdma descriptor */
280         __u64                     tx_cookie;    /* identify this tx to peer */
281         kra_msg_t                 tx_msg;       /* FMA message buffer */
282 } kra_tx_t;
283
284 #define RANAL_BUF_NONE           0              /* buffer type not set */
285 #define RANAL_BUF_IMMEDIATE      1              /* immediate data */
286 #define RANAL_BUF_PHYS_UNMAPPED  2              /* physical: not mapped yet */
287 #define RANAL_BUF_PHYS_MAPPED    3              /* physical: mapped already */
288 #define RANAL_BUF_VIRT_UNMAPPED  4              /* virtual: not mapped yet */
289 #define RANAL_BUF_VIRT_MAPPED    5              /* virtual: mapped already */
290
291 #define RANAL_TX_IDLE            0x00           /* on freelist */
292 #define RANAL_TX_SIMPLE          0x10           /* about to send a simple message */
293 #define RANAL_TX_PUTI_REQ        0x20           /* PUT initiator about to send PUT_REQ */
294 #define RANAL_TX_PUTI_WAIT_ACK   0x21           /* PUT initiator waiting for PUT_ACK */
295 #define RANAL_TX_PUTI_RDMA       0x22           /* PUT initiator waiting for RDMA to complete */
296 #define RANAL_TX_PUTI_DONE       0x23           /* PUT initiator about to send PUT_DONE */
297 #define RANAL_TX_PUTT_NAK        0x30           /* PUT target about to send PUT_NAK */
298 #define RANAL_TX_PUTT_ACK        0x30           /* PUT target about to send PUT_ACK */
299 #define RANAL_TX_PUTT_WAIT_DONE  0x31           /* PUT target waiting for PUT_DONE */
300 #define RANAL_TX_GETI_REQ        0x40           /* GET initiator about to send GET_REQ */
301 #define RANAL_TX_GETI_WAIT_DONE  0x41           /* GET initiator waiting for GET_DONE */
302 #define RANAL_TX_GETT_NAK        0x50           /* GET target about to send PUT_NAK */
303 #define RANAL_TX_GETT_RDMA       0x51           /* GET target waiting for RDMA to complete */
304 #define RANAL_TX_GETT_DONE       0x52           /* GET target about to send GET_DONE */
305
306 typedef struct kra_conn
307
308         struct kra_peer    *rac_peer;           /* owning peer */
309         struct list_head    rac_list;           /* stash on peer's conn list */
310         struct list_head    rac_hashlist;       /* stash in connection hash table */
311         struct list_head    rac_schedlist;      /* schedule (on rad_connq) for attention */
312         struct list_head    rac_fmaq;           /* txs queued for FMA */
313         struct list_head    rac_rdmaq;          /* txs awaiting RDMA completion */
314         struct list_head    rac_replyq;         /* txs awaiting replies */
315         __u64               rac_peerstamp;      /* peer's unique stamp */
316         __u64               rac_peer_connstamp; /* peer's unique connection stamp */
317         __u64               rac_my_connstamp;   /* my unique connection stamp */
318         unsigned long       rac_last_tx;        /* when I last sent an FMA message */
319         unsigned long       rac_last_rx;        /* when I last received an FMA messages */
320         long                rac_keepalive;      /* keepalive interval */
321         long                rac_timeout;        /* infer peer death on (last_rx + timout > now) */
322         __u32               rac_cqid;           /* my completion callback id (non-unique) */
323         __u32               rac_tx_seq;         /* tx msg sequence number */
324         __u32               rac_rx_seq;         /* rx msg sequence number */
325         atomic_t            rac_refcount;       /* # users */
326         unsigned int        rac_close_sent;     /* I've sent CLOSE */
327         unsigned int        rac_close_recvd;    /* I've received CLOSE */
328         unsigned int        rac_state;          /* connection state */
329         unsigned int        rac_scheduled;      /* being attented to */
330         spinlock_t          rac_lock;           /* serialise */
331         kra_device_t       *rac_device;         /* which device */
332         RAP_PVOID           rac_rihandle;       /* RA endpoint */
333         kra_msg_t          *rac_rxmsg;          /* incoming message (FMA prefix) */
334         kra_msg_t           rac_msg;            /* keepalive/CLOSE message buffer */
335 } kra_conn_t;
336
337 #define RANAL_CONN_ESTABLISHED     0
338 #define RANAL_CONN_CLOSING         1
339 #define RANAL_CONN_CLOSED          2
340
341 typedef struct kra_peer
342 {
343         struct list_head    rap_list;           /* stash on global peer list */
344         struct list_head    rap_connd_list;     /* schedule on kra_connd_peers */
345         struct list_head    rap_conns;          /* all active connections */
346         struct list_head    rap_tx_queue;       /* msgs waiting for a conn */
347         ptl_nid_t           rap_nid;            /* who's on the other end(s) */
348         __u32               rap_ip;             /* IP address of peer */
349         int                 rap_port;           /* port on which peer listens */
350         atomic_t            rap_refcount;       /* # users */
351         int                 rap_persistence;    /* "known" peer refs */
352         int                 rap_connecting;     /* connection forming */
353         unsigned long       rap_reconnect_time; /* CURRENT_TIME when reconnect OK */
354         unsigned long       rap_reconnect_interval; /* exponential backoff */
355 } kra_peer_t;
356
357 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,6,0))
358 # define sk_allocation  allocation
359 # define sk_data_ready  data_ready
360 # define sk_write_space write_space
361 # define sk_user_data   user_data
362 # define sk_prot        prot
363 # define sk_sndbuf      sndbuf
364 # define sk_socket      socket
365 # define sk_wmem_queued wmem_queued
366 # define sk_err         err
367 # define sk_sleep       sleep
368 #endif
369
370 extern lib_nal_t       kranal_lib;
371 extern kra_data_t      kranal_data;
372 extern kra_tunables_t  kranal_tunables;
373
374 extern void kranal_destroy_peer(kra_peer_t *peer);
375 extern void kranal_destroy_conn(kra_conn_t *conn);
376
377 static inline void
378 kranal_peer_addref(kra_peer_t *peer)
379 {
380         CDEBUG(D_NET, "%p->"LPX64"\n", peer, peer->rap_nid);
381         LASSERT(atomic_read(&peer->rap_refcount) > 0);
382         atomic_inc(&peer->rap_refcount);
383 }
384
385 static inline void
386 kranal_peer_decref(kra_peer_t *peer)
387 {
388         CDEBUG(D_NET, "%p->"LPX64"\n", peer, peer->rap_nid);
389         LASSERT(atomic_read(&peer->rap_refcount) > 0);
390         if (atomic_dec_and_test(&peer->rap_refcount))
391                 kranal_destroy_peer(peer);
392 }
393
394 static inline struct list_head *
395 kranal_nid2peerlist (ptl_nid_t nid) 
396 {
397         unsigned int hash = ((unsigned int)nid) % kranal_data.kra_peer_hash_size;
398         
399         return (&kranal_data.kra_peers[hash]);
400 }
401
402 static inline int
403 kranal_peer_active(kra_peer_t *peer)
404 {
405         /* Am I in the peer hash table? */
406         return (!list_empty(&peer->rap_list));
407 }
408
409 static inline void
410 kranal_conn_addref(kra_conn_t *conn)
411 {
412         CDEBUG(D_NET, "%p->"LPX64"\n", conn, conn->rac_peer->rap_nid);
413         LASSERT(atomic_read(&conn->rac_refcount) > 0);
414         atomic_inc(&conn->rac_refcount);
415 }
416
417 static inline void
418 kranal_conn_decref(kra_conn_t *conn)
419 {
420         CDEBUG(D_NET, "%p->"LPX64"\n", conn, conn->rac_peer->rap_nid);
421         LASSERT(atomic_read(&conn->rac_refcount) > 0);
422         if (atomic_dec_and_test(&conn->rac_refcount))
423                 kranal_destroy_conn(conn);
424 }
425
426 static inline struct list_head *
427 kranal_cqid2connlist (__u32 cqid) 
428 {
429         unsigned int hash = cqid % kranal_data.kra_conn_hash_size;
430         
431         return (&kranal_data.kra_conns [hash]);
432 }
433
434 static inline kra_conn_t *
435 kranal_cqid2conn_locked (__u32 cqid) 
436 {
437         struct list_head *conns = kranal_cqid2connlist(cqid);
438         struct list_head *tmp;
439         kra_conn_t       *conn;
440         
441         list_for_each(tmp, conns) {
442                 conn = list_entry(tmp, kra_conn_t, rac_hashlist);
443                 
444                 if (conn->rac_cqid == cqid)
445                         return conn;
446         }
447         
448         return NULL;
449 }
450
451 static inline int
452 kranal_tx_mapped (kra_tx_t *tx)
453 {
454         return (tx->tx_buftype == RANAL_BUF_VIRT_MAPPED ||
455                 tx->tx_buftype == RANAL_BUF_PHYS_MAPPED);
456 }
457
458 #if CONFIG_X86
459 static inline __u64
460 kranal_page2phys (struct page *p)
461 {
462         __u64 page_number = p - mem_map;
463         
464         return (page_number << PAGE_SHIFT);
465 }
466 #else
467 # error "no page->phys"
468 #endif
469
470 extern void kranal_free_acceptsock (kra_acceptsock_t *ras);
471 extern int kranal_listener_procint (ctl_table *table, 
472                                     int write, struct file *filp, 
473                                     void *buffer, size_t *lenp);
474 extern void kranal_update_reaper_timeout (long timeout);
475 extern void kranal_tx_done (kra_tx_t *tx, int completion);
476 extern void kranal_unlink_peer_locked (kra_peer_t *peer);
477 extern void kranal_schedule_conn (kra_conn_t *conn);
478 extern kra_peer_t *kranal_create_peer (ptl_nid_t nid);
479 extern kra_peer_t *kranal_find_peer_locked (ptl_nid_t nid);
480 extern void kranal_post_fma (kra_conn_t *conn, kra_tx_t *tx);
481 extern int kranal_del_peer (ptl_nid_t nid, int single_share);
482 extern void kranal_device_callback (RAP_INT32 devid);
483 extern int kranal_thread_start (int(*fn)(void *arg), void *arg);
484 extern int kranal_connd (void *arg);
485 extern int kranal_reaper (void *arg);
486 extern int kranal_scheduler (void *arg);
487 extern void kranal_close_conn_locked (kra_conn_t *conn, int error);
488 extern void kranal_terminate_conn_locked (kra_conn_t *conn);
489 extern void kranal_connect (kra_peer_t *peer);
490 extern int kranal_conn_handshake (struct socket *sock, kra_peer_t *peer);