Whamcloud - gitweb
land 1.0.1 fixes on main development branch (head)
[fs/lustre-release.git] / lnet / klnds / socklnd / socklnd.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * Copyright (C) 2001, 2002 Cluster File Systems, Inc.
5  *   Author: Zach Brown <zab@zabbo.net>
6  *   Author: Peter J. Braam <braam@clusterfs.com>
7  *   Author: Phil Schwan <phil@clusterfs.com>
8  *   Author: Eric Barton <eric@bartonsoftware.com>
9  *
10  *   This file is part of Portals, http://www.sf.net/projects/lustre/
11  *
12  *   Portals 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.
15  *
16  *   Portals 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.
20  *
21  *   You should have received a copy of the GNU General Public License
22  *   along with Portals; if not, write to the Free Software
23  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24  *
25  */
26
27 #define DEBUG_PORTAL_ALLOC
28 #ifndef EXPORT_SYMTAB
29 # define EXPORT_SYMTAB
30 #endif
31
32 #include <linux/config.h>
33 #include <linux/module.h>
34 #include <linux/kernel.h>
35 #include <linux/mm.h>
36 #include <linux/string.h>
37 #include <linux/stat.h>
38 #include <linux/errno.h>
39 #include <linux/smp_lock.h>
40 #include <linux/unistd.h>
41 #include <net/sock.h>
42 #include <net/tcp.h>
43 #include <linux/uio.h>
44
45 #include <asm/system.h>
46 #include <asm/uaccess.h>
47
48 #include <linux/fs.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 <asm/uaccess.h>
55 #include <asm/segment.h>
56 #include <asm/div64.h>
57
58 #define DEBUG_SUBSYSTEM S_SOCKNAL
59
60 #include <linux/kp30.h>
61 #include <portals/p30.h>
62 #include <portals/lib-p30.h>
63 #include <portals/socknal.h>
64
65 #if CONFIG_SMP
66 # define SOCKNAL_N_SCHED       num_online_cpus() /* # socknal schedulers */
67 #else
68 # define SOCKNAL_N_SCHED        1               /* # socknal schedulers */
69 #endif
70 #define SOCKNAL_N_AUTOCONNECTD  4               /* # socknal autoconnect daemons */
71
72 #define SOCKNAL_MIN_RECONNECT_INTERVAL  HZ      /* first failed connection retry... */
73 #define SOCKNAL_MAX_RECONNECT_INTERVAL  (60*HZ) /* ...exponentially increasing to this */
74
75 /* default vals for runtime tunables */
76 #define SOCKNAL_IO_TIMEOUT       50             /* default comms timeout (seconds) */
77 #define SOCKNAL_EAGER_ACK        0              /* default eager ack (boolean) */
78 #define SOCKNAL_TYPED_CONNS      1              /* unidirectional large, bidirectional small? */
79 #define SOCKNAL_ZC_MIN_FRAG     (2<<10)         /* default smallest zerocopy fragment */
80 #define SOCKNAL_MIN_BULK        (1<<10)         /* smallest "large" message */
81 #define SOCKNAL_USE_KEEPALIVES   0              /* use tcp/ip keepalive? */
82
83 #define SOCKNAL_PEER_HASH_SIZE   101            /* # peer lists */
84
85 #define SOCKNAL_SMALL_FWD_NMSGS 128             /* # small messages I can be forwarding at any time */
86 #define SOCKNAL_LARGE_FWD_NMSGS 64              /* # large messages I can be forwarding at any time */
87
88 #define SOCKNAL_SMALL_FWD_PAGES 1               /* # pages in a small message fwd buffer */
89
90 #define SOCKNAL_LARGE_FWD_PAGES (PAGE_ALIGN (sizeof (ptl_hdr_t) + PTL_MTU) >> PAGE_SHIFT)
91                                                 /* # pages in a large message fwd buffer */
92
93 #define SOCKNAL_RESCHED         100             /* # scheduler loops before reschedule */
94
95 #define SOCKNAL_TX_LOW_WATER(sk) (((sk)->sk_sndbuf*8)/10)
96
97 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,72))
98 # define sk_data_ready  data_ready
99 # define sk_write_space write_space
100 # define sk_user_data   user_data
101 # define sk_prot        prot
102 # define sk_sndbuf      sndbuf
103 # define sk_socket      socket
104 #endif
105
106 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,6,0))
107 # define sk_wmem_queued wmem_queued
108 #endif
109
110 typedef struct                                  /* pool of forwarding buffers */
111 {
112         spinlock_t        fmp_lock;             /* serialise */
113         struct list_head  fmp_idle_fmbs;        /* free buffers */
114         struct list_head  fmp_blocked_conns;    /* connections waiting for a buffer */
115         int               fmp_nactive_fmbs;     /* # buffers in use */
116 } ksock_fmb_pool_t;
117
118
119 typedef struct                                  /* per scheduler state */
120 {
121         spinlock_t        kss_lock;             /* serialise */
122         struct list_head  kss_rx_conns;         /* conn waiting to be read */
123         struct list_head  kss_tx_conns;         /* conn waiting to be written */
124 #if SOCKNAL_ZC
125         struct list_head  kss_zctxdone_list;    /* completed ZC transmits */
126 #endif
127         wait_queue_head_t kss_waitq;            /* where scheduler sleeps */
128         int               kss_nconns;           /* # connections assigned to this scheduler */
129 } ksock_sched_t;
130
131 typedef struct {
132         int               ksni_valid:1;         /* been set yet? */
133         int               ksni_bound:1;         /* bound to a cpu yet? */
134         int               ksni_sched:6;         /* which scheduler (assumes < 64) */
135 } ksock_irqinfo_t;
136
137 typedef struct {
138         int               ksnd_init;            /* initialisation state */
139         int               ksnd_io_timeout;      /* "stuck" socket timeout (seconds) */
140         int               ksnd_eager_ack;       /* make TCP ack eagerly? */
141         int               ksnd_typed_conns;     /* drive sockets by type? */
142         int               ksnd_min_bulk;        /* smallest "large" message */
143 #if SOCKNAL_ZC
144         unsigned int      ksnd_zc_min_frag;     /* minimum zero copy frag size */
145 #endif
146         struct ctl_table_header *ksnd_sysctl;   /* sysctl interface */
147         __u64             ksnd_incarnation;     /* my epoch */
148         
149         rwlock_t          ksnd_global_lock;     /* stabilize peer/conn ops */
150         struct list_head *ksnd_peers;           /* hash table of all my known peers */
151         int               ksnd_peer_hash_size;  /* size of ksnd_peers */
152
153         nal_cb_t         *ksnd_nal_cb;
154         spinlock_t        ksnd_nal_cb_lock;     /* lib cli/sti lock */
155
156         atomic_t          ksnd_nthreads;        /* # live threads */
157         int               ksnd_shuttingdown;    /* tell threads to exit */
158         ksock_sched_t    *ksnd_schedulers;      /* scheduler state */
159
160         atomic_t          ksnd_npeers;          /* total # peers extant */
161         atomic_t          ksnd_nclosing_conns;  /* # closed conns extant */
162
163         kpr_router_t      ksnd_router;          /* THE router */
164
165         ksock_fmb_pool_t  ksnd_small_fmp;       /* small message forwarding buffers */
166         ksock_fmb_pool_t  ksnd_large_fmp;       /* large message forwarding buffers */
167
168         atomic_t          ksnd_nactive_ltxs;    /* #active ltxs */
169
170         struct list_head  ksnd_deathrow_conns;  /* conns to be closed */
171         struct list_head  ksnd_zombie_conns;    /* conns to be freed */
172         wait_queue_head_t ksnd_reaper_waitq;    /* reaper sleep here */
173         spinlock_t        ksnd_reaper_lock;     /* serialise */
174
175         int               ksnd_stall_tx;        /* test sluggish sender */
176         int               ksnd_stall_rx;        /* test sluggish receiver */
177
178         struct list_head  ksnd_autoconnectd_routes; /* routes waiting to be connected */
179         wait_queue_head_t ksnd_autoconnectd_waitq; /* autoconnectds sleep here */
180         spinlock_t        ksnd_autoconnectd_lock; /* serialise */
181
182         ksock_irqinfo_t   ksnd_irqinfo[NR_IRQS];/* irq->scheduler lookup */
183 } ksock_nal_data_t;
184
185 #define SOCKNAL_INIT_NOTHING    0
186 #define SOCKNAL_INIT_DATA       1
187 #define SOCKNAL_INIT_PTL        2
188 #define SOCKNAL_INIT_ALL        3
189
190 /* A packet just assembled for transmission is represented by 1 or more
191  * struct iovec fragments and 0 or more ptl_kiov_t fragments.  Forwarded
192  * messages, or messages from an MD with PTL_MD_KIOV _not_ set have 0
193  * ptl_kiov_t fragments.  Messages from an MD with PTL_MD_KIOV set, have 1
194  * struct iovec fragment (the header) and up to PTL_MD_MAX_IOV ptl_kiov_t
195  * fragments.
196  *
197  * On the receive side, initially 1 struct iovec fragment is posted for
198  * receive (the header).  Once the header has been received, if the message
199  * requires forwarding or will be received into mapped memory, up to
200  * PTL_MD_MAX_IOV struct iovec fragments describe the target memory.
201  * Otherwise up to PTL_MD_MAX_IOV ptl_kiov_t fragments are used.
202  */
203
204 struct ksock_conn;                              /* forward ref */
205 struct ksock_peer;                              /* forward ref */
206 struct ksock_route;                             /* forward ref */
207
208 typedef struct                                  /* transmit packet */
209 {
210         struct list_head        tx_list;        /* queue on conn for transmission etc */
211         char                    tx_isfwd;       /* forwarding / sourced here */
212         int                     tx_nob;         /* # packet bytes */
213         int                     tx_resid;       /* residual bytes */
214         int                     tx_niov;        /* # packet iovec frags */
215         struct iovec           *tx_iov;         /* packet iovec frags */
216         int                     tx_nkiov;       /* # packet page frags */
217         ptl_kiov_t             *tx_kiov;        /* packet page frags */
218         struct ksock_conn      *tx_conn;        /* owning conn */
219         ptl_hdr_t              *tx_hdr;         /* packet header (for debug only) */
220 #if SOCKNAL_ZC        
221         zccd_t                  tx_zccd;        /* zero copy callback descriptor */
222 #endif
223 } ksock_tx_t;
224
225 #define KSOCK_ZCCD_2_TX(ptr)    list_entry (ptr, ksock_tx_t, tx_zccd)
226 /* network zero copy callback descriptor embedded in ksock_tx_t */
227
228 typedef struct                                  /* locally transmitted packet */
229 {
230         ksock_tx_t              ltx_tx;         /* send info */
231         void                   *ltx_private;    /* lib_finalize() callback arg */
232         void                   *ltx_cookie;     /* lib_finalize() callback arg */
233         ptl_hdr_t               ltx_hdr;        /* buffer for packet header */
234         int                     ltx_desc_size;  /* bytes allocated for this desc */
235         struct iovec            ltx_iov[1];     /* iov for hdr + payload */
236         ptl_kiov_t              ltx_kiov[0];    /* kiov for payload */
237 } ksock_ltx_t;
238
239 #define KSOCK_TX_2_KPR_FWD_DESC(ptr)    list_entry ((kprfd_scratch_t *)ptr, kpr_fwd_desc_t, kprfd_scratch)
240 /* forwarded packets (router->socknal) embedded in kpr_fwd_desc_t::kprfd_scratch */
241
242 #define KSOCK_TX_2_KSOCK_LTX(ptr)       list_entry (ptr, ksock_ltx_t, ltx_tx)
243 /* local packets (lib->socknal) embedded in ksock_ltx_t::ltx_tx */
244
245 /* NB list_entry() is used here as convenient macro for calculating a
246  * pointer to a struct from the address of a member. */
247
248 typedef struct                                  /* Kernel portals Socket Forwarding message buffer */
249 {                                               /* (socknal->router) */
250         struct list_head        fmb_list;       /* queue idle */
251         kpr_fwd_desc_t          fmb_fwd;        /* router's descriptor */
252         int                     fmb_npages;     /* # pages allocated */
253         ksock_fmb_pool_t       *fmb_pool;       /* owning pool */
254         struct ksock_peer      *fmb_peer;       /* peer received from */
255         struct page            *fmb_pages[SOCKNAL_LARGE_FWD_PAGES];
256         struct iovec            fmb_iov[SOCKNAL_LARGE_FWD_PAGES];
257 } ksock_fmb_t;
258
259 /* space for the rx frag descriptors; we either read a single contiguous
260  * header, or PTL_MD_MAX_IOV frags of payload of either type. */
261 typedef union {
262         struct iovec    iov[PTL_MD_MAX_IOV];
263         ptl_kiov_t      kiov[PTL_MD_MAX_IOV];
264 } ksock_rxiovspace_t;
265
266 #define SOCKNAL_RX_HEADER       1               /* reading header */
267 #define SOCKNAL_RX_BODY         2               /* reading body (to deliver here) */
268 #define SOCKNAL_RX_BODY_FWD     3               /* reading body (to forward) */
269 #define SOCKNAL_RX_SLOP         4               /* skipping body */
270 #define SOCKNAL_RX_GET_FMB      5               /* scheduled for forwarding */
271 #define SOCKNAL_RX_FMB_SLEEP    6               /* blocked waiting for a fwd desc */
272
273 typedef struct ksock_conn
274
275         struct ksock_peer  *ksnc_peer;          /* owning peer */
276         struct ksock_route *ksnc_route;         /* owning route */
277         struct list_head    ksnc_list;          /* stash on peer's conn list */
278         struct socket      *ksnc_sock;          /* actual socket */
279         void               *ksnc_saved_data_ready; /* socket's original data_ready() callback */
280         void               *ksnc_saved_write_space; /* socket's original write_space() callback */
281         atomic_t            ksnc_refcount;      /* # users */
282         ksock_sched_t      *ksnc_scheduler;     /* who schedules this connection */
283         __u32               ksnc_ipaddr;        /* peer's IP */
284         int                 ksnc_port;          /* peer's port */
285         int                 ksnc_closing;       /* being shut down */
286         int                 ksnc_type;          /* type of connection */
287         __u64               ksnc_incarnation;   /* peer's incarnation */
288         
289         /* reader */
290         struct list_head    ksnc_rx_list;       /* where I enq waiting input or a forwarding descriptor */
291         unsigned long       ksnc_rx_deadline;   /* when (in jiffies) receive times out */
292         int                 ksnc_rx_started;    /* started receiving a message */
293         int                 ksnc_rx_ready;      /* data ready to read */
294         int                 ksnc_rx_scheduled;  /* being progressed */
295         int                 ksnc_rx_state;      /* what is being read */
296         int                 ksnc_rx_nob_left;   /* # bytes to next hdr/body  */
297         int                 ksnc_rx_nob_wanted; /* bytes actually wanted */
298         int                 ksnc_rx_niov;       /* # iovec frags */
299         struct iovec       *ksnc_rx_iov;        /* the iovec frags */
300         int                 ksnc_rx_nkiov;      /* # page frags */
301         ptl_kiov_t         *ksnc_rx_kiov;       /* the page frags */
302         ksock_rxiovspace_t  ksnc_rx_iov_space;  /* space for frag descriptors */
303         void               *ksnc_cookie;        /* rx lib_finalize passthru arg */
304         ptl_hdr_t           ksnc_hdr;           /* where I read headers into */
305
306         /* WRITER */
307         struct list_head    ksnc_tx_list;       /* where I enq waiting for output space */
308         struct list_head    ksnc_tx_queue;      /* packets waiting to be sent */
309         unsigned long       ksnc_tx_deadline;   /* when (in jiffies) tx times out */
310         atomic_t            ksnc_tx_nob;        /* # bytes queued */
311         int                 ksnc_tx_ready;      /* write space */
312         int                 ksnc_tx_scheduled;  /* being progressed */
313 } ksock_conn_t;
314
315 #define KSNR_TYPED_ROUTES   ((1 << SOCKNAL_CONN_CONTROL) |      \
316                              (1 << SOCKNAL_CONN_BULK_IN) |      \
317                              (1 << SOCKNAL_CONN_BULK_OUT))
318
319 typedef struct ksock_route
320 {
321         struct list_head    ksnr_list;          /* chain on peer route list */
322         struct list_head    ksnr_connect_list;  /* chain on autoconnect list */
323         struct ksock_peer  *ksnr_peer;          /* owning peer */
324         atomic_t            ksnr_refcount;      /* # users */
325         int                 ksnr_sharecount;    /* lconf usage counter */
326         unsigned long       ksnr_timeout;       /* when (in jiffies) reconnection can happen next */
327         unsigned int        ksnr_retry_interval; /* how long between retries */
328         __u32               ksnr_ipaddr;        /* an IP address for this peer */
329         int                 ksnr_port;          /* port to connect to */
330         int                 ksnr_buffer_size;   /* size of socket buffers */
331         unsigned int        ksnr_irq_affinity:1; /* set affinity? */
332         unsigned int        ksnr_nonagel:1;     /* disable nagle? */
333         unsigned int        ksnr_eager:1;       /* connect eagery? */
334         unsigned int        ksnr_connecting:4;  /* autoconnects in progress by type */
335         unsigned int        ksnr_connected:4;   /* connections established by type */
336         unsigned int        ksnr_deleted:1;     /* been removed from peer? */
337         int                 ksnr_conn_count;    /* # conns established by this route */
338 } ksock_route_t;
339
340 typedef struct ksock_peer
341 {
342         struct list_head    ksnp_list;          /* stash on global peer list */
343         ptl_nid_t           ksnp_nid;           /* who's on the other end(s) */
344         atomic_t            ksnp_refcount;      /* # users */
345         int                 ksnp_closing;       /* being closed */
346         int                 ksnp_error;         /* errno on closing last conn */
347         struct list_head    ksnp_conns;         /* all active connections */
348         struct list_head    ksnp_routes;        /* routes */
349         struct list_head    ksnp_tx_queue;      /* waiting packets */
350         unsigned long       ksnp_last_alive;    /* when (in jiffies) I was last alive */
351 } ksock_peer_t;
352
353
354 extern nal_cb_t         ksocknal_lib;
355 extern ksock_nal_data_t ksocknal_data;
356
357 static inline struct list_head *
358 ksocknal_nid2peerlist (ptl_nid_t nid) 
359 {
360         unsigned int hash = ((unsigned int)nid) % ksocknal_data.ksnd_peer_hash_size;
361         
362         return (&ksocknal_data.ksnd_peers [hash]);
363 }
364
365 static inline int
366 ksocknal_getconnsock (ksock_conn_t *conn) 
367 {
368         int   rc = -ESHUTDOWN;
369         
370         read_lock (&ksocknal_data.ksnd_global_lock);
371         if (!conn->ksnc_closing) {
372                 rc = 0;
373                 get_file (conn->ksnc_sock->file);
374         }
375         read_unlock (&ksocknal_data.ksnd_global_lock);
376
377         return (rc);
378 }
379
380 static inline void
381 ksocknal_putconnsock (ksock_conn_t *conn)
382 {
383         fput (conn->ksnc_sock->file);
384 }
385
386 extern void ksocknal_put_route (ksock_route_t *route);
387 extern void ksocknal_put_peer (ksock_peer_t *peer);
388 extern ksock_peer_t *ksocknal_find_peer_locked (ptl_nid_t nid);
389 extern ksock_peer_t *ksocknal_get_peer (ptl_nid_t nid);
390 extern int ksocknal_del_route (ptl_nid_t nid, __u32 ipaddr,
391                                int single, int keep_conn);
392 extern int ksocknal_create_conn (ksock_route_t *route,
393                                  struct socket *sock, int bind_irq, int type);
394 extern void ksocknal_close_conn_locked (ksock_conn_t *conn, int why);
395 extern void ksocknal_terminate_conn (ksock_conn_t *conn);
396 extern void ksocknal_destroy_conn (ksock_conn_t *conn);
397 extern void ksocknal_put_conn (ksock_conn_t *conn);
398 extern int ksocknal_close_stale_conns_locked (ksock_peer_t *peer, __u64 incarnation);
399 extern int ksocknal_close_conn_and_siblings (ksock_conn_t *conn, int why);
400 extern int ksocknal_close_matching_conns (ptl_nid_t nid, __u32 ipaddr);
401
402 extern void ksocknal_queue_tx_locked (ksock_tx_t *tx, ksock_conn_t *conn);
403 extern void ksocknal_tx_done (ksock_tx_t *tx, int asynch);
404 extern void ksocknal_fwd_packet (void *arg, kpr_fwd_desc_t *fwd);
405 extern void ksocknal_fmb_callback (void *arg, int error);
406 extern void ksocknal_notify (void *arg, ptl_nid_t gw_nid, int alive);
407 extern int ksocknal_thread_start (int (*fn)(void *arg), void *arg);
408 extern int ksocknal_new_packet (ksock_conn_t *conn, int skip);
409 extern int ksocknal_scheduler (void *arg);
410 extern void ksocknal_data_ready(struct sock *sk, int n);
411 extern void ksocknal_write_space(struct sock *sk);
412 extern int ksocknal_autoconnectd (void *arg);
413 extern int ksocknal_reaper (void *arg);
414 extern int ksocknal_setup_sock (struct socket *sock);
415 extern int ksocknal_hello (struct socket *sock, 
416                            ptl_nid_t *nid, int *type, __u64 *incarnation);