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 #include <linux/config.h>
32 #include <linux/module.h>
33 #include <linux/kernel.h>
35 #include <linux/string.h>
36 #include <linux/stat.h>
37 #include <linux/errno.h>
38 #include <linux/smp_lock.h>
39 #include <linux/unistd.h>
42 #include <linux/uio.h>
44 #include <asm/system.h>
45 #include <asm/uaccess.h>
48 #include <linux/init.h>
50 #include <linux/file.h>
51 #include <linux/stat.h>
52 #include <linux/list.h>
53 #include <linux/kmod.h>
54 #include <linux/sysctl.h>
55 #include <asm/uaccess.h>
56 #include <asm/segment.h>
57 #include <asm/div64.h>
59 #define DEBUG_SUBSYSTEM S_NAL
61 #include <linux/kp30.h>
62 #include <linux/portals_compat25.h>
63 #include <linux/kpr.h>
64 #include <portals/p30.h>
65 #include <portals/lib-p30.h>
66 #include <portals/nal.h>
67 #include <portals/socknal.h>
69 #define SOCKNAL_N_AUTOCONNECTD 4 /* # socknal autoconnect daemons */
71 #define SOCKNAL_MIN_RECONNECT_INTERVAL HZ /* first failed connection retry... */
72 #define SOCKNAL_MAX_RECONNECT_INTERVAL (60*HZ) /* ...exponentially increasing to this */
74 /* default vals for runtime tunables */
75 #define SOCKNAL_IO_TIMEOUT 50 /* default comms timeout (seconds) */
76 #define SOCKNAL_EAGER_ACK 0 /* default eager ack (boolean) */
77 #define SOCKNAL_TYPED_CONNS 1 /* unidirectional large, bidirectional small? */
78 #define SOCKNAL_ZC_MIN_FRAG (2<<10) /* default smallest zerocopy fragment */
79 #define SOCKNAL_MIN_BULK (1<<10) /* smallest "large" message */
80 #define SOCKNAL_BUFFER_SIZE (8<<20) /* default socket buffer size */
81 #define SOCKNAL_NAGLE 0 /* enable/disable NAGLE? */
82 #define SOCKNAL_IRQ_AFFINITY 1 /* enable/disable IRQ affinity? */
83 #define SOCKNAL_KEEPALIVE_IDLE 30 /* # seconds idle before 1st probe */
84 #define SOCKNAL_KEEPALIVE_COUNT 10 /* # unanswered probes to determine peer death */
85 #define SOCKNAL_KEEPALIVE_INTVL 2 /* seconds between probes */
87 #define SOCKNAL_PEER_HASH_SIZE 101 /* # peer lists */
89 #define SOCKNAL_SMALL_FWD_NMSGS 128 /* # small messages I can be forwarding at any time */
90 #define SOCKNAL_LARGE_FWD_NMSGS 64 /* # large messages I can be forwarding at any time */
92 #define SOCKNAL_SMALL_FWD_PAGES 1 /* # pages in a small message fwd buffer */
94 #define SOCKNAL_LARGE_FWD_PAGES (PAGE_ALIGN(PTL_MTU) >> PAGE_SHIFT)
95 /* # pages in a large message fwd buffer */
97 #define SOCKNAL_RESCHED 100 /* # scheduler loops before reschedule */
98 #define SOCKNAL_ENOMEM_RETRY 1 /* jiffies between retries */
100 #define SOCKNAL_MAX_INTERFACES 16 /* Largest number of interfaces we bind */
102 #define SOCKNAL_ROUND_ROBIN 0 /* round robin / load balance */
104 #define SOCKNAL_TX_LOW_WATER(sk) (((sk)->sk_sndbuf*8)/10)
106 #define SOCKNAL_SINGLE_FRAG_TX 0 /* disable multi-fragment sends */
107 #define SOCKNAL_SINGLE_FRAG_RX 0 /* disable multi-fragment receives */
109 /* risk kmap deadlock on multi-frag I/O (backs off to single-frag if disabled).
110 * no risk if we're not running on a CONFIG_HIGHMEM platform. */
111 #ifdef CONFIG_HIGHMEM
112 # define SOCKNAL_RISK_KMAP_DEADLOCK 0
114 # define SOCKNAL_RISK_KMAP_DEADLOCK 1
117 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,72))
118 # define sk_allocation allocation
119 # define sk_data_ready data_ready
120 # define sk_write_space write_space
121 # define sk_user_data user_data
122 # define sk_prot prot
123 # define sk_sndbuf sndbuf
124 # define sk_socket socket
127 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,6,0))
128 # define sk_wmem_queued wmem_queued
132 typedef struct /* pool of forwarding buffers */
134 spinlock_t fmp_lock; /* serialise */
135 struct list_head fmp_idle_fmbs; /* free buffers */
136 struct list_head fmp_blocked_conns; /* connections waiting for a buffer */
137 int fmp_nactive_fmbs; /* # buffers in use */
138 int fmp_buff_pages; /* # pages per buffer */
142 typedef struct /* per scheduler state */
144 spinlock_t kss_lock; /* serialise */
145 struct list_head kss_rx_conns; /* conn waiting to be read */
146 struct list_head kss_tx_conns; /* conn waiting to be written */
148 struct list_head kss_zctxdone_list; /* completed ZC transmits */
150 wait_queue_head_t kss_waitq; /* where scheduler sleeps */
151 int kss_nconns; /* # connections assigned to this scheduler */
156 int ksni_valid:1; /* been set yet? */
157 int ksni_bound:1; /* bound to a cpu yet? */
158 int ksni_sched:6; /* which scheduler (assumes < 64) */
163 __u32 ksni_ipaddr; /* interface's IP address */
164 __u32 ksni_netmask; /* interface's network mask */
165 int ksni_nroutes; /* # routes using (active) */
166 int ksni_npeers; /* # peers using (passive) */
171 int ksnd_io_timeout; /* "stuck" socket timeout (seconds) */
172 int ksnd_eager_ack; /* make TCP ack eagerly? */
173 int ksnd_typed_conns; /* drive sockets by type? */
174 int ksnd_min_bulk; /* smallest "large" message */
175 int ksnd_buffer_size; /* socket buffer size */
176 int ksnd_nagle; /* enable NAGLE? */
177 int ksnd_irq_affinity; /* enable IRQ affinity? */
178 int ksnd_keepalive_idle; /* # idle secs before 1st probe */
179 int ksnd_keepalive_count; /* # probes */
180 int ksnd_keepalive_intvl; /* time between probes */
182 unsigned int ksnd_zc_min_frag; /* minimum zero copy frag size */
184 struct ctl_table_header *ksnd_sysctl; /* sysctl interface */
189 int ksnd_init; /* initialisation state */
190 __u64 ksnd_incarnation; /* my epoch */
192 rwlock_t ksnd_global_lock; /* stabilize peer/conn ops */
193 struct list_head *ksnd_peers; /* hash table of all my known peers */
194 int ksnd_peer_hash_size; /* size of ksnd_peers */
196 int ksnd_nthreads; /* # live threads */
197 int ksnd_shuttingdown; /* tell threads to exit */
198 int ksnd_nschedulers; /* # schedulers */
199 ksock_sched_t *ksnd_schedulers; /* their state */
201 atomic_t ksnd_npeers; /* total # peers extant */
202 atomic_t ksnd_nclosing_conns; /* # closed conns extant */
204 kpr_router_t ksnd_router; /* THE router */
206 ksock_fmb_pool_t ksnd_small_fmp; /* small message forwarding buffers */
207 ksock_fmb_pool_t ksnd_large_fmp; /* large message forwarding buffers */
209 atomic_t ksnd_nactive_ltxs; /* #active ltxs */
211 struct list_head ksnd_deathrow_conns; /* conns to be closed */
212 struct list_head ksnd_zombie_conns; /* conns to be freed */
213 struct list_head ksnd_enomem_conns; /* conns to be retried */
214 wait_queue_head_t ksnd_reaper_waitq; /* reaper sleeps here */
215 unsigned long ksnd_reaper_waketime; /* when reaper will wake */
216 spinlock_t ksnd_reaper_lock; /* serialise */
218 int ksnd_enomem_tx; /* test ENOMEM sender */
219 int ksnd_stall_tx; /* test sluggish sender */
220 int ksnd_stall_rx; /* test sluggish receiver */
222 struct list_head ksnd_autoconnectd_routes; /* routes waiting to be connected */
223 wait_queue_head_t ksnd_autoconnectd_waitq; /* autoconnectds sleep here */
224 spinlock_t ksnd_autoconnectd_lock; /* serialise */
226 ksock_irqinfo_t ksnd_irqinfo[NR_IRQS];/* irq->scheduler lookup */
228 int ksnd_ninterfaces;
229 ksock_interface_t ksnd_interfaces[SOCKNAL_MAX_INTERFACES]; /* published interfaces */
232 #define SOCKNAL_INIT_NOTHING 0
233 #define SOCKNAL_INIT_DATA 1
234 #define SOCKNAL_INIT_LIB 2
235 #define SOCKNAL_INIT_ALL 3
237 /* A packet just assembled for transmission is represented by 1 or more
238 * struct iovec fragments (the first frag contains the portals header),
239 * followed by 0 or more ptl_kiov_t fragments.
241 * On the receive side, initially 1 struct iovec fragment is posted for
242 * receive (the header). Once the header has been received, the payload is
243 * received into either struct iovec or ptl_kiov_t fragments, depending on
244 * what the header matched or whether the message needs forwarding. */
246 struct ksock_conn; /* forward ref */
247 struct ksock_peer; /* forward ref */
248 struct ksock_route; /* forward ref */
250 typedef struct /* transmit packet */
252 struct list_head tx_list; /* queue on conn for transmission etc */
253 char tx_isfwd; /* forwarding / sourced here */
254 int tx_nob; /* # packet bytes */
255 int tx_resid; /* residual bytes */
256 int tx_niov; /* # packet iovec frags */
257 struct iovec *tx_iov; /* packet iovec frags */
258 int tx_nkiov; /* # packet page frags */
259 ptl_kiov_t *tx_kiov; /* packet page frags */
260 struct ksock_conn *tx_conn; /* owning conn */
261 ptl_hdr_t *tx_hdr; /* packet header (for debug only) */
263 zccd_t tx_zccd; /* zero copy callback descriptor */
267 typedef struct /* forwarded packet */
269 ksock_tx_t ftx_tx; /* send info */
270 struct iovec ftx_iov; /* hdr iovec */
273 #define KSOCK_ZCCD_2_TX(ptr) list_entry (ptr, ksock_tx_t, tx_zccd)
274 /* network zero copy callback descriptor embedded in ksock_tx_t */
276 typedef struct /* locally transmitted packet */
278 ksock_tx_t ltx_tx; /* send info */
279 void *ltx_private; /* lib_finalize() callback arg */
280 void *ltx_cookie; /* lib_finalize() callback arg */
281 ptl_hdr_t ltx_hdr; /* buffer for packet header */
282 int ltx_desc_size; /* bytes allocated for this desc */
283 struct iovec ltx_iov[1]; /* iov for hdr + payload */
284 ptl_kiov_t ltx_kiov[0]; /* kiov for payload */
287 #define KSOCK_TX_2_KPR_FWD_DESC(ptr) list_entry ((kprfd_scratch_t *)ptr, kpr_fwd_desc_t, kprfd_scratch)
288 /* forwarded packets (router->socknal) embedded in kpr_fwd_desc_t::kprfd_scratch */
290 #define KSOCK_TX_2_KSOCK_LTX(ptr) list_entry (ptr, ksock_ltx_t, ltx_tx)
291 /* local packets (lib->socknal) embedded in ksock_ltx_t::ltx_tx */
293 /* NB list_entry() is used here as convenient macro for calculating a
294 * pointer to a struct from the address of a member. */
296 typedef struct /* Kernel portals Socket Forwarding message buffer */
297 { /* (socknal->router) */
298 struct list_head fmb_list; /* queue idle */
299 kpr_fwd_desc_t fmb_fwd; /* router's descriptor */
300 ksock_fmb_pool_t *fmb_pool; /* owning pool */
301 struct ksock_peer *fmb_peer; /* peer received from */
302 ptl_hdr_t fmb_hdr; /* message header */
303 ptl_kiov_t fmb_kiov[0]; /* payload frags */
306 /* space for the rx frag descriptors; we either read a single contiguous
307 * header, or up to PTL_MD_MAX_IOV frags of payload of either type. */
309 struct iovec iov[PTL_MD_MAX_IOV];
310 ptl_kiov_t kiov[PTL_MD_MAX_IOV];
311 } ksock_rxiovspace_t;
313 #define SOCKNAL_RX_HEADER 1 /* reading header */
314 #define SOCKNAL_RX_BODY 2 /* reading body (to deliver here) */
315 #define SOCKNAL_RX_BODY_FWD 3 /* reading body (to forward) */
316 #define SOCKNAL_RX_SLOP 4 /* skipping body */
317 #define SOCKNAL_RX_GET_FMB 5 /* scheduled for forwarding */
318 #define SOCKNAL_RX_FMB_SLEEP 6 /* blocked waiting for a fwd desc */
320 typedef struct ksock_conn
322 struct ksock_peer *ksnc_peer; /* owning peer */
323 struct ksock_route *ksnc_route; /* owning route */
324 struct list_head ksnc_list; /* stash on peer's conn list */
325 struct socket *ksnc_sock; /* actual socket */
326 void *ksnc_saved_data_ready; /* socket's original data_ready() callback */
327 void *ksnc_saved_write_space; /* socket's original write_space() callback */
328 atomic_t ksnc_refcount; /* # users */
329 ksock_sched_t *ksnc_scheduler; /* who schedules this connection */
330 __u32 ksnc_myipaddr; /* my IP */
331 __u32 ksnc_ipaddr; /* peer's IP */
332 int ksnc_port; /* peer's port */
333 int ksnc_closing; /* being shut down */
334 int ksnc_type; /* type of connection */
335 __u64 ksnc_incarnation; /* peer's incarnation */
338 struct list_head ksnc_rx_list; /* where I enq waiting input or a forwarding descriptor */
339 unsigned long ksnc_rx_deadline; /* when (in jiffies) receive times out */
340 int ksnc_rx_started; /* started receiving a message */
341 int ksnc_rx_ready; /* data ready to read */
342 int ksnc_rx_scheduled; /* being progressed */
343 int ksnc_rx_state; /* what is being read */
344 int ksnc_rx_nob_left; /* # bytes to next hdr/body */
345 int ksnc_rx_nob_wanted; /* bytes actually wanted */
346 int ksnc_rx_niov; /* # iovec frags */
347 struct iovec *ksnc_rx_iov; /* the iovec frags */
348 int ksnc_rx_nkiov; /* # page frags */
349 ptl_kiov_t *ksnc_rx_kiov; /* the page frags */
350 ksock_rxiovspace_t ksnc_rx_iov_space; /* space for frag descriptors */
351 void *ksnc_cookie; /* rx lib_finalize passthru arg */
352 ptl_hdr_t ksnc_hdr; /* where I read headers into */
355 struct list_head ksnc_tx_list; /* where I enq waiting for output space */
356 struct list_head ksnc_tx_queue; /* packets waiting to be sent */
357 unsigned long ksnc_tx_deadline; /* when (in jiffies) tx times out */
358 int ksnc_tx_bufnob; /* send buffer marker */
359 atomic_t ksnc_tx_nob; /* # bytes queued */
360 int ksnc_tx_ready; /* write space */
361 int ksnc_tx_scheduled; /* being progressed */
363 #if !SOCKNAL_SINGLE_FRAG_RX
364 struct iovec ksnc_rx_scratch_iov[PTL_MD_MAX_IOV];
366 #if !SOCKNAL_SINGLE_FRAG_TX
367 struct iovec ksnc_tx_scratch_iov[PTL_MD_MAX_IOV];
371 #define KSNR_TYPED_ROUTES ((1 << SOCKNAL_CONN_CONTROL) | \
372 (1 << SOCKNAL_CONN_BULK_IN) | \
373 (1 << SOCKNAL_CONN_BULK_OUT))
375 typedef struct ksock_route
377 struct list_head ksnr_list; /* chain on peer route list */
378 struct list_head ksnr_connect_list; /* chain on autoconnect list */
379 struct ksock_peer *ksnr_peer; /* owning peer */
380 atomic_t ksnr_refcount; /* # users */
381 unsigned long ksnr_timeout; /* when (in jiffies) reconnection can happen next */
382 unsigned int ksnr_retry_interval; /* how long between retries */
383 __u32 ksnr_myipaddr; /* my IP */
384 __u32 ksnr_ipaddr; /* IP address to connect to */
385 int ksnr_port; /* port to connect to */
386 unsigned int ksnr_connecting:4; /* autoconnects in progress by type */
387 unsigned int ksnr_connected:4; /* connections established by type */
388 unsigned int ksnr_deleted:1; /* been removed from peer? */
389 unsigned int ksnr_share_count; /* created explicitly? */
390 int ksnr_conn_count; /* # conns established by this route */
393 typedef struct ksock_peer
395 struct list_head ksnp_list; /* stash on global peer list */
396 ptl_nid_t ksnp_nid; /* who's on the other end(s) */
397 atomic_t ksnp_refcount; /* # users */
398 int ksnp_sharecount; /* lconf usage counter */
399 int ksnp_closing; /* being closed */
400 int ksnp_error; /* errno on closing last conn */
401 struct list_head ksnp_conns; /* all active connections */
402 struct list_head ksnp_routes; /* routes */
403 struct list_head ksnp_tx_queue; /* waiting packets */
404 unsigned long ksnp_last_alive; /* when (in jiffies) I was last alive */
405 int ksnp_n_passive_ips; /* # of... */
406 __u32 ksnp_passive_ips[SOCKNAL_MAX_INTERFACES]; /* preferred local interfaces */
410 extern lib_nal_t ksocknal_lib;
411 extern ksock_nal_data_t ksocknal_data;
412 extern ksock_tunables_t ksocknal_tunables;
414 static inline struct list_head *
415 ksocknal_nid2peerlist (ptl_nid_t nid)
417 unsigned int hash = ((unsigned int)nid) % ksocknal_data.ksnd_peer_hash_size;
419 return (&ksocknal_data.ksnd_peers [hash]);
423 ksocknal_getconnsock (ksock_conn_t *conn)
427 read_lock (&ksocknal_data.ksnd_global_lock);
428 if (!conn->ksnc_closing) {
430 get_file (conn->ksnc_sock->file);
432 read_unlock (&ksocknal_data.ksnd_global_lock);
438 ksocknal_putconnsock (ksock_conn_t *conn)
440 fput (conn->ksnc_sock->file);
445 int ksocknal_nsched(void)
450 #include <linux/lustre_version.h>
451 # if !(defined(CONFIG_X86) && (LINUX_VERSION_CODE >= KERNEL_VERSION(2,4,21))) || defined(CONFIG_X86_64) || (LUSTRE_KERNEL_VERSION < 39) || ((LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,0)) && !defined(CONFIG_X86_HT))
453 ksocknal_nsched(void)
455 return num_online_cpus();
459 ksocknal_sched2cpu(int i)
465 ksocknal_irqsched2cpu(int i)
471 ksocknal_nsched(void)
473 if (smp_num_siblings == 1)
474 return (num_online_cpus());
476 /* We need to know if this assumption is crap */
477 LASSERT (smp_num_siblings == 2);
478 return (num_online_cpus()/2);
482 ksocknal_sched2cpu(int i)
484 if (smp_num_siblings == 1)
491 ksocknal_irqsched2cpu(int i)
493 return (ksocknal_sched2cpu(i) + 1);
498 extern void ksocknal_put_route (ksock_route_t *route);
499 extern void ksocknal_put_peer (ksock_peer_t *peer);
500 extern ksock_peer_t *ksocknal_find_peer_locked (ptl_nid_t nid);
501 extern ksock_peer_t *ksocknal_get_peer (ptl_nid_t nid);
502 extern int ksocknal_del_route (ptl_nid_t nid, __u32 ipaddr,
503 int single, int keep_conn);
504 extern int ksocknal_create_conn (ksock_route_t *route,
505 struct socket *sock, int type);
506 extern void ksocknal_close_conn_locked (ksock_conn_t *conn, int why);
507 extern void ksocknal_terminate_conn (ksock_conn_t *conn);
508 extern void ksocknal_destroy_conn (ksock_conn_t *conn);
509 extern void ksocknal_put_conn (ksock_conn_t *conn);
510 extern int ksocknal_close_stale_conns_locked (ksock_peer_t *peer, __u64 incarnation);
511 extern int ksocknal_close_conn_and_siblings (ksock_conn_t *conn, int why);
512 extern int ksocknal_close_matching_conns (ptl_nid_t nid, __u32 ipaddr);
514 extern void ksocknal_queue_tx_locked (ksock_tx_t *tx, ksock_conn_t *conn);
515 extern void ksocknal_tx_done (ksock_tx_t *tx, int asynch);
516 extern void ksocknal_fwd_packet (void *arg, kpr_fwd_desc_t *fwd);
517 extern void ksocknal_fmb_callback (void *arg, int error);
518 extern void ksocknal_notify (void *arg, ptl_nid_t gw_nid, int alive);
519 extern int ksocknal_thread_start (int (*fn)(void *arg), void *arg);
520 extern int ksocknal_new_packet (ksock_conn_t *conn, int skip);
521 extern int ksocknal_scheduler (void *arg);
522 extern void ksocknal_data_ready(struct sock *sk, int n);
523 extern void ksocknal_write_space(struct sock *sk);
524 extern int ksocknal_autoconnectd (void *arg);
525 extern int ksocknal_reaper (void *arg);
526 extern int ksocknal_get_conn_tunables (ksock_conn_t *conn, int *txmem,
527 int *rxmem, int *nagle);
528 extern int ksocknal_setup_sock (struct socket *sock);
529 extern int ksocknal_send_hello (ksock_conn_t *conn, __u32 *ipaddrs, int nipaddrs);
530 extern int ksocknal_recv_hello (ksock_conn_t *conn,
531 ptl_nid_t *nid, __u64 *incarnation, __u32 *ipaddrs);