1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Author: Zach Brown <zab@zabbo.net>
5 * Author: Peter J. Braam <braam@clusterfs.com>
6 * Author: Phil Schwan <phil@clusterfs.com>
7 * Author: Eric Barton <eric@bartonsoftware.com>
9 * This file is part of Lustre, http://www.lustre.org
11 * Portals is free software; you can redistribute it and/or
12 * modify it under the terms of version 2 of the GNU General Public
13 * License as published by the Free Software Foundation.
15 * Portals is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with Portals; if not, write to the Free Software
22 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #define DEBUG_PORTAL_ALLOC
28 # define EXPORT_SYMTAB
31 #define DEBUG_SUBSYSTEM S_NAL
33 #if defined(__linux__)
34 #include "socknal_lib-linux.h"
35 #elif defined(__APPLE__)
36 #include "socknal_lib-darwin.h"
38 #error Unsupported Operating System
41 #include <libcfs/kp30.h>
42 #include <portals/kpr.h>
43 #include <portals/p30.h>
44 #include <portals/lib-p30.h>
45 #include <portals/nal.h>
46 #include <portals/socknal.h>
48 #define SOCKNAL_N_AUTOCONNECTD 4 /* # socknal autoconnect daemons */
50 #define SOCKNAL_MIN_RECONNECT_INTERVAL cfs_time_seconds(1) /* first failed connection retry... */
51 #define SOCKNAL_MAX_RECONNECT_INTERVAL cfs_time_seconds(60) /* ...exponentially increasing to this */
53 /* default vals for runtime tunables */
54 #define SOCKNAL_IO_TIMEOUT 50 /* default comms timeout (seconds) */
55 #define SOCKNAL_EAGER_ACK SOCKNAL_ARCH_EAGER_ACK /* default eager ack (boolean) */
56 #define SOCKNAL_TYPED_CONNS 1 /* unidirectional large, bidirectional small? */
57 #define SOCKNAL_ZC_MIN_FRAG (2<<10) /* default smallest zerocopy fragment */
58 #define SOCKNAL_MIN_BULK (1<<10) /* smallest "large" message */
59 #define SOCKNAL_BUFFER_SIZE (8<<20) /* default socket buffer size */
60 #define SOCKNAL_NAGLE 0 /* enable/disable NAGLE? */
61 #define SOCKNAL_IRQ_AFFINITY 1 /* enable/disable IRQ affinity? */
63 /* FIXME: for debugging purpose only, remove asap! -bzzz */
65 #define SOCKNAL_KEEPALIVE_IDLE 30 /* # seconds idle before 1st probe */
67 #define SOCKNAL_KEEPALIVE_IDLE 0 /* # seconds idle before 1st probe */
69 #define SOCKNAL_KEEPALIVE_COUNT 10 /* # unanswered probes to determine peer death */
70 #define SOCKNAL_KEEPALIVE_INTVL 2 /* seconds between probes */
72 #define SOCKNAL_PEER_HASH_SIZE 101 /* # peer lists */
74 #define SOCKNAL_SMALL_FWD_NMSGS 128 /* # small messages I can be forwarding at any time */
75 #define SOCKNAL_LARGE_FWD_NMSGS 64 /* # large messages I can be forwarding at any time */
77 #define SOCKNAL_SMALL_FWD_PAGES 1 /* # pages in a small message fwd buffer */
79 #define SOCKNAL_LARGE_FWD_PAGES (PAGE_ALIGN(PTL_MTU) >> PAGE_SHIFT)
80 /* # pages in a large message fwd buffer */
82 #define SOCKNAL_RESCHED 100 /* # scheduler loops before reschedule */
83 #define SOCKNAL_ENOMEM_RETRY CFS_MIN_DELAY /* jiffies between retries */
85 #define SOCKNAL_MAX_INTERFACES 16 /* Largest number of interfaces we bind */
87 #define SOCKNAL_ROUND_ROBIN 0 /* round robin / load balance */
89 #define SOCKNAL_SINGLE_FRAG_TX 0 /* disable multi-fragment sends */
90 #define SOCKNAL_SINGLE_FRAG_RX 0 /* disable multi-fragment receives */
92 /* risk kmap deadlock on multi-frag I/O (backs off to single-frag if disabled).
93 * no risk if we're not running on a CONFIG_HIGHMEM platform. */
95 # define SOCKNAL_RISK_KMAP_DEADLOCK 0
97 # define SOCKNAL_RISK_KMAP_DEADLOCK 1
100 typedef struct /* pool of forwarding buffers */
102 spinlock_t fmp_lock; /* serialise */
103 struct list_head fmp_idle_fmbs; /* free buffers */
104 struct list_head fmp_blocked_conns; /* connections waiting for a buffer */
105 int fmp_nactive_fmbs; /* # buffers in use */
106 int fmp_buff_pages; /* # pages per buffer */
110 typedef struct /* per scheduler state */
112 spinlock_t kss_lock; /* serialise */
113 struct list_head kss_rx_conns; /* conn waiting to be read */
114 struct list_head kss_tx_conns; /* conn waiting to be written */
116 struct list_head kss_zctxdone_list; /* completed ZC transmits */
118 cfs_waitq_t kss_waitq; /* where scheduler sleeps */
119 int kss_nconns; /* # connections assigned to this scheduler */
124 int ksni_valid:1; /* been set yet? */
125 int ksni_bound:1; /* bound to a cpu yet? */
126 int ksni_sched:6; /* which scheduler (assumes < 64) */
131 __u32 ksni_ipaddr; /* interface's IP address */
132 __u32 ksni_netmask; /* interface's network mask */
133 int ksni_nroutes; /* # routes using (active) */
134 int ksni_npeers; /* # peers using (passive) */
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 int ksnd_buffer_size; /* socket buffer size */
144 int ksnd_nagle; /* enable NAGLE? */
145 int ksnd_irq_affinity; /* enable IRQ affinity? */
146 int ksnd_keepalive_idle; /* # idle secs before 1st probe */
147 int ksnd_keepalive_count; /* # probes */
148 int ksnd_keepalive_intvl; /* time between probes */
150 unsigned int ksnd_zc_min_frag; /* minimum zero copy frag size */
152 cfs_sysctl_table_header_t *ksnd_sysctl; /* sysctl interface */
157 int ksnd_init; /* initialisation state */
158 __u64 ksnd_incarnation; /* my epoch */
160 rwlock_t ksnd_global_lock; /* stabilize peer/conn ops */
161 struct list_head *ksnd_peers; /* hash table of all my known peers */
162 int ksnd_peer_hash_size; /* size of ksnd_peers */
164 int ksnd_nthreads; /* # live threads */
165 int ksnd_shuttingdown; /* tell threads to exit */
166 int ksnd_nschedulers; /* # schedulers */
167 ksock_sched_t *ksnd_schedulers; /* their state */
169 atomic_t ksnd_npeers; /* total # peers extant */
170 atomic_t ksnd_nclosing_conns; /* # closed conns extant */
172 kpr_router_t ksnd_router; /* THE router */
174 ksock_fmb_pool_t ksnd_small_fmp; /* small message forwarding buffers */
175 ksock_fmb_pool_t ksnd_large_fmp; /* large message forwarding buffers */
177 atomic_t ksnd_nactive_ltxs; /* #active ltxs */
179 struct list_head ksnd_deathrow_conns; /* conns to close: reaper_lock*/
180 struct list_head ksnd_zombie_conns; /* conns to free: reaper_lock */
181 struct list_head ksnd_enomem_conns; /* conns to retry: reaper_lock*/
182 cfs_waitq_t ksnd_reaper_waitq; /* reaper sleeps here */
183 cfs_time_t ksnd_reaper_waketime; /* when reaper will wake */
184 spinlock_t ksnd_reaper_lock; /* serialise */
186 int ksnd_enomem_tx; /* test ENOMEM sender */
187 int ksnd_stall_tx; /* test sluggish sender */
188 int ksnd_stall_rx; /* test sluggish receiver */
190 struct list_head ksnd_autoconnectd_routes; /* routes waiting to be connected */
191 cfs_waitq_t ksnd_autoconnectd_waitq; /* autoconnectds sleep here */
192 spinlock_t ksnd_autoconnectd_lock; /* serialise */
194 ksock_irqinfo_t ksnd_irqinfo[NR_IRQS];/* irq->scheduler lookup */
196 int ksnd_ninterfaces;
197 ksock_interface_t ksnd_interfaces[SOCKNAL_MAX_INTERFACES]; /* published interfaces */
200 #define SOCKNAL_INIT_NOTHING 0
201 #define SOCKNAL_INIT_DATA 1
202 #define SOCKNAL_INIT_LIB 2
203 #define SOCKNAL_INIT_ALL 3
205 /* A packet just assembled for transmission is represented by 1 or more
206 * struct iovec fragments (the first frag contains the portals header),
207 * followed by 0 or more ptl_kiov_t fragments.
209 * On the receive side, initially 1 struct iovec fragment is posted for
210 * receive (the header). Once the header has been received, the payload is
211 * received into either struct iovec or ptl_kiov_t fragments, depending on
212 * what the header matched or whether the message needs forwarding. */
214 struct ksock_conn; /* forward ref */
215 struct ksock_peer; /* forward ref */
216 struct ksock_route; /* forward ref */
218 typedef struct /* transmit packet */
220 struct list_head tx_list; /* queue on conn for transmission etc */
221 char tx_isfwd; /* forwarding / sourced here */
222 int tx_nob; /* # packet bytes */
223 int tx_resid; /* residual bytes */
224 int tx_niov; /* # packet iovec frags */
225 struct iovec *tx_iov; /* packet iovec frags */
226 int tx_nkiov; /* # packet page frags */
227 ptl_kiov_t *tx_kiov; /* packet page frags */
228 struct ksock_conn *tx_conn; /* owning conn */
229 ptl_hdr_t *tx_hdr; /* packet header (for debug only) */
231 zccd_t tx_zccd; /* zero copy callback descriptor */
235 typedef struct /* forwarded packet */
237 ksock_tx_t ftx_tx; /* send info */
238 struct iovec ftx_iov; /* hdr iovec */
241 #define KSOCK_ZCCD_2_TX(ptr) list_entry (ptr, ksock_tx_t, tx_zccd)
242 /* network zero copy callback descriptor embedded in ksock_tx_t */
244 typedef struct /* locally transmitted packet */
246 ksock_tx_t ltx_tx; /* send info */
247 void *ltx_private; /* lib_finalize() callback arg */
248 void *ltx_cookie; /* lib_finalize() callback arg */
249 ptl_hdr_t ltx_hdr; /* buffer for packet header */
250 int ltx_desc_size; /* bytes allocated for this desc */
251 struct iovec ltx_iov[1]; /* iov for hdr + payload */
252 ptl_kiov_t ltx_kiov[0]; /* kiov for payload */
255 #define KSOCK_TX_2_KPR_FWD_DESC(ptr) list_entry ((kprfd_scratch_t *)ptr, kpr_fwd_desc_t, kprfd_scratch)
256 /* forwarded packets (router->socknal) embedded in kpr_fwd_desc_t::kprfd_scratch */
258 #define KSOCK_TX_2_KSOCK_LTX(ptr) list_entry (ptr, ksock_ltx_t, ltx_tx)
259 /* local packets (lib->socknal) embedded in ksock_ltx_t::ltx_tx */
261 /* NB list_entry() is used here as convenient macro for calculating a
262 * pointer to a struct from the address of a member. */
264 typedef struct /* Kernel portals Socket Forwarding message buffer */
265 { /* (socknal->router) */
266 struct list_head fmb_list; /* queue idle */
267 kpr_fwd_desc_t fmb_fwd; /* router's descriptor */
268 ksock_fmb_pool_t *fmb_pool; /* owning pool */
269 struct ksock_peer *fmb_peer; /* peer received from */
270 ptl_hdr_t fmb_hdr; /* message header */
271 ptl_kiov_t fmb_kiov[0]; /* payload frags */
274 /* space for the rx frag descriptors; we either read a single contiguous
275 * header, or up to PTL_MD_MAX_IOV frags of payload of either type. */
277 struct iovec iov[PTL_MD_MAX_IOV];
278 ptl_kiov_t kiov[PTL_MD_MAX_IOV];
279 } ksock_rxiovspace_t;
281 #define SOCKNAL_RX_HEADER 1 /* reading header */
282 #define SOCKNAL_RX_BODY 2 /* reading body (to deliver here) */
283 #define SOCKNAL_RX_BODY_FWD 3 /* reading body (to forward) */
284 #define SOCKNAL_RX_SLOP 4 /* skipping body */
285 #define SOCKNAL_RX_GET_FMB 5 /* scheduled for forwarding */
286 #define SOCKNAL_RX_FMB_SLEEP 6 /* blocked waiting for a fwd desc */
288 typedef struct ksock_conn
290 struct ksock_peer *ksnc_peer; /* owning peer */
291 struct ksock_route *ksnc_route; /* owning route */
292 struct list_head ksnc_list; /* stash on peer's conn list */
293 struct socket *ksnc_sock; /* actual socket */
294 void *ksnc_saved_data_ready; /* socket's original data_ready() callback */
295 void *ksnc_saved_write_space; /* socket's original write_space() callback */
296 atomic_t ksnc_refcount; /* # users */
297 ksock_sched_t *ksnc_scheduler; /* who schedules this connection */
298 __u32 ksnc_myipaddr; /* my IP */
299 __u32 ksnc_ipaddr; /* peer's IP */
300 int ksnc_port; /* peer's port */
301 int ksnc_closing; /* being shut down */
302 int ksnc_type; /* type of connection */
303 __u64 ksnc_incarnation; /* peer's incarnation */
306 struct list_head ksnc_rx_list; /* where I enq waiting input or a forwarding descriptor */
307 cfs_time_t ksnc_rx_deadline; /* when (in jiffies) receive times out */
308 int ksnc_rx_started; /* started receiving a message */
309 int ksnc_rx_ready; /* data ready to read */
310 int ksnc_rx_scheduled; /* being progressed */
311 int ksnc_rx_state; /* what is being read */
312 int ksnc_rx_nob_left; /* # bytes to next hdr/body */
313 int ksnc_rx_nob_wanted; /* bytes actually wanted */
314 int ksnc_rx_niov; /* # iovec frags */
315 struct iovec *ksnc_rx_iov; /* the iovec frags */
316 int ksnc_rx_nkiov; /* # page frags */
317 ptl_kiov_t *ksnc_rx_kiov; /* the page frags */
318 ksock_rxiovspace_t ksnc_rx_iov_space; /* space for frag descriptors */
319 void *ksnc_cookie; /* rx lib_finalize passthru arg */
320 ptl_hdr_t ksnc_hdr; /* where I read headers into */
323 struct list_head ksnc_tx_list; /* where I enq waiting for output space */
324 struct list_head ksnc_tx_queue; /* packets waiting to be sent */
325 cfs_time_t ksnc_tx_deadline; /* when (in jiffies) tx times out */
326 int ksnc_tx_bufnob; /* send buffer marker */
327 atomic_t ksnc_tx_nob; /* # bytes queued */
328 int ksnc_tx_ready; /* write space */
329 int ksnc_tx_scheduled; /* being progressed */
331 #if !SOCKNAL_SINGLE_FRAG_RX
332 struct iovec ksnc_rx_scratch_iov[PTL_MD_MAX_IOV];
334 #if !SOCKNAL_SINGLE_FRAG_TX
335 struct iovec ksnc_tx_scratch_iov[PTL_MD_MAX_IOV];
339 #define KSNR_TYPED_ROUTES ((1 << SOCKNAL_CONN_CONTROL) | \
340 (1 << SOCKNAL_CONN_BULK_IN) | \
341 (1 << SOCKNAL_CONN_BULK_OUT))
343 typedef struct ksock_route
345 struct list_head ksnr_list; /* chain on peer route list */
346 struct list_head ksnr_connect_list; /* chain on autoconnect list */
347 struct ksock_peer *ksnr_peer; /* owning peer */
348 atomic_t ksnr_refcount; /* # users */
349 cfs_time_t ksnr_timeout; /* when (in jiffies) reconnection can happen next */
350 cfs_duration_t ksnr_retry_interval; /* how long between retries */
351 __u32 ksnr_myipaddr; /* my IP */
352 __u32 ksnr_ipaddr; /* IP address to connect to */
353 int ksnr_port; /* port to connect to */
354 unsigned int ksnr_connecting:1; /* autoconnect in progress */
355 unsigned int ksnr_connected:4; /* connections established by type */
356 unsigned int ksnr_deleted:1; /* been removed from peer? */
357 unsigned int ksnr_share_count; /* created explicitly? */
358 int ksnr_conn_count; /* # conns established by this route */
361 typedef struct ksock_peer
363 struct list_head ksnp_list; /* stash on global peer list */
364 ptl_nid_t ksnp_nid; /* who's on the other end(s) */
365 atomic_t ksnp_refcount; /* # users */
366 int ksnp_sharecount; /* lconf usage counter */
367 int ksnp_closing; /* being closed */
368 int ksnp_error; /* errno on closing last conn */
369 struct list_head ksnp_conns; /* all active connections */
370 struct list_head ksnp_routes; /* routes */
371 struct list_head ksnp_tx_queue; /* waiting packets */
372 cfs_time_t ksnp_last_alive; /* when (in jiffies) I was last alive */
373 int ksnp_n_passive_ips; /* # of... */
374 __u32 ksnp_passive_ips[SOCKNAL_MAX_INTERFACES]; /* preferred local interfaces */
378 extern lib_nal_t ksocknal_lib;
379 extern ksock_nal_data_t ksocknal_data;
380 extern ksock_tunables_t ksocknal_tunables;
382 static inline struct list_head *
383 ksocknal_nid2peerlist (ptl_nid_t nid)
385 unsigned int hash = ((unsigned int)nid) % ksocknal_data.ksnd_peer_hash_size;
387 return (&ksocknal_data.ksnd_peers [hash]);
391 ksocknal_getconnsock (ksock_conn_t *conn)
395 read_lock (&ksocknal_data.ksnd_global_lock);
396 if (!conn->ksnc_closing) {
398 cfs_get_file (KSN_CONN2FILE(conn));
400 read_unlock (&ksocknal_data.ksnd_global_lock);
406 ksocknal_putconnsock (ksock_conn_t *conn)
408 cfs_put_file (KSN_CONN2FILE(conn));
411 extern void ksocknal_put_route (ksock_route_t *route);
412 extern void ksocknal_put_peer (ksock_peer_t *peer);
413 extern ksock_peer_t *ksocknal_find_peer_locked (ptl_nid_t nid);
414 extern ksock_peer_t *ksocknal_get_peer (ptl_nid_t nid);
415 extern int ksocknal_del_route (ptl_nid_t nid, __u32 ipaddr,
416 int single, int keep_conn);
417 extern int ksocknal_create_conn (ksock_route_t *route,
418 struct socket *sock, int type);
419 extern void ksocknal_close_conn_locked (ksock_conn_t *conn, int why);
420 extern void ksocknal_terminate_conn (ksock_conn_t *conn);
421 extern void ksocknal_destroy_conn (ksock_conn_t *conn);
422 extern void ksocknal_put_conn (ksock_conn_t *conn);
423 extern int ksocknal_close_stale_conns_locked (ksock_peer_t *peer, __u64 incarnation);
424 extern int ksocknal_close_conn_and_siblings (ksock_conn_t *conn, int why);
425 extern int ksocknal_close_matching_conns (ptl_nid_t nid, __u32 ipaddr);
427 extern void ksocknal_queue_tx_locked (ksock_tx_t *tx, ksock_conn_t *conn);
428 extern void ksocknal_tx_done (ksock_tx_t *tx, int asynch);
429 extern void ksocknal_fwd_packet (void *arg, kpr_fwd_desc_t *fwd);
430 extern void ksocknal_fmb_callback (void *arg, int error);
431 extern void ksocknal_notify (void *arg, ptl_nid_t gw_nid, int alive);
432 extern int ksocknal_thread_start (int (*fn)(void *arg), void *arg);
433 extern int ksocknal_new_packet (ksock_conn_t *conn, int skip);
434 extern int ksocknal_scheduler (void *arg);
435 extern int ksocknal_autoconnectd (void *arg);
436 extern int ksocknal_reaper (void *arg);
437 extern int ksocknal_setup_sock (struct socket *sock);
438 extern int ksocknal_send_hello (ksock_conn_t *conn, __u32 *ipaddrs, int nipaddrs);
439 extern int ksocknal_recv_hello (ksock_conn_t *conn,
440 ptl_nid_t *nid, __u64 *incarnation, __u32 *ipaddrs);
442 extern void ksocknal_lib_save_callback(struct socket *sock, ksock_conn_t *conn);
443 extern void ksocknal_lib_set_callback(struct socket *sock, ksock_conn_t *conn);
444 extern void ksocknal_lib_act_callback(struct socket *sock, ksock_conn_t *conn);
445 extern void ksocknal_lib_reset_callback(struct socket *sock, ksock_conn_t *conn);
446 extern void ksocknal_lib_push_conn (ksock_conn_t *conn);
447 extern void ksocknal_lib_bind_irq (unsigned int irq);
448 extern int ksocknal_lib_get_conn_addrs (ksock_conn_t *conn);
449 extern unsigned int ksocknal_lib_sock_irq (struct socket *sock);
450 extern int ksocknal_lib_setup_sock (struct socket *so);
451 extern int ksocknal_lib_send_iov (ksock_conn_t *conn, ksock_tx_t *tx);
452 extern int ksocknal_lib_send_kiov (ksock_conn_t *conn, ksock_tx_t *tx);
453 extern void ksocknal_lib_eager_ack (ksock_conn_t *conn);
454 extern int ksocknal_lib_recv_iov (ksock_conn_t *conn);
455 extern int ksocknal_lib_recv_kiov (ksock_conn_t *conn);
456 extern int ksocknal_lib_sock_write (struct socket *sock,
457 void *buffer, int nob);
458 extern int ksocknal_lib_sock_read (struct socket *sock,
459 void *buffer, int nob);
460 extern int ksocknal_lib_get_conn_tunables (ksock_conn_t *conn, int *txmem,
461 int *rxmem, int *nagle);
462 extern int ksocknal_lib_connect_sock(struct socket **sockp, int *may_retry,
463 ksock_route_t *route, int local_port);