1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 #define DEBUG_SUBSYSTEM S_RPC
40 # include <liblustre.h>
42 # include <libcfs/libcfs.h>
44 # include <linux/kernel.h>
48 #include <obd_class.h>
49 #include <lustre_net.h>
50 #include <lustre_sec.h>
51 #include "ptlrpc_internal.h"
53 lnet_handle_eq_t ptlrpc_eq_h;
56 * Client's outgoing request callback
58 void request_out_callback(lnet_event_t *ev)
60 struct ptlrpc_cb_id *cbid = ev->md.user_ptr;
61 struct ptlrpc_request *req = cbid->cbid_arg;
64 LASSERT (ev->type == LNET_EVENT_SEND ||
65 ev->type == LNET_EVENT_UNLINK);
66 LASSERT (ev->unlinked);
68 DEBUG_REQ((ev->status == 0) ? D_NET : D_ERROR, req,
69 "type %d, status %d", ev->type, ev->status);
71 sptlrpc_request_out_callback(req);
73 if (ev->type == LNET_EVENT_UNLINK || ev->status != 0) {
75 /* Failed send: make it seem like the reply timed out, just
76 * like failing sends in client.c does currently... */
78 spin_lock(&req->rq_lock);
80 spin_unlock(&req->rq_lock);
82 ptlrpc_client_wake_req(req);
85 ptlrpc_req_finished(req);
91 * Client's incoming reply callback
93 void reply_in_callback(lnet_event_t *ev)
95 struct ptlrpc_cb_id *cbid = ev->md.user_ptr;
96 struct ptlrpc_request *req = cbid->cbid_arg;
99 DEBUG_REQ((ev->status == 0) ? D_NET : D_ERROR, req,
100 "type %d, status %d", ev->type, ev->status);
102 LASSERT (ev->type == LNET_EVENT_PUT || ev->type == LNET_EVENT_UNLINK);
103 LASSERT (ev->md.start == req->rq_repbuf);
104 LASSERT (ev->mlength <= req->rq_repbuf_len);
105 /* We've set LNET_MD_MANAGE_REMOTE for all outgoing requests
106 for adaptive timeouts' early reply. */
107 LASSERT((ev->md.options & LNET_MD_MANAGE_REMOTE) != 0);
109 spin_lock(&req->rq_lock);
111 req->rq_receiving_reply = 0;
114 req->rq_must_unlink = 0;
118 if (ev->type == LNET_EVENT_UNLINK) {
119 LASSERT(ev->unlinked);
120 DEBUG_REQ(D_RPCTRACE, req, "unlink");
124 if ((ev->offset == 0) &&
125 ((lustre_msghdr_get_flags(req->rq_reqmsg) & MSGHDR_AT_SUPPORT))) {
127 DEBUG_REQ(D_ADAPTTO, req,
128 "Early reply received: mlen=%u offset=%d replen=%d "
129 "replied=%d unlinked=%d", ev->mlength, ev->offset,
130 req->rq_replen, req->rq_replied, ev->unlinked);
132 req->rq_early_count++; /* number received, client side */
134 if (req->rq_replied) /* already got the real reply */
138 req->rq_reply_off = ev->offset;
139 req->rq_nob_received = ev->mlength;
140 /* And we're still receiving */
141 req->rq_receiving_reply = 1;
144 req->rq_rep_swab_mask = 0;
146 req->rq_reply_off = ev->offset;
147 req->rq_nob_received = ev->mlength;
148 /* LNetMDUnlink can't be called under the LNET_LOCK,
149 so we must unlink in ptlrpc_unregister_reply */
150 DEBUG_REQ(D_INFO, req,
151 "reply in flags=%x mlen=%u offset=%d replen=%d",
152 lustre_msg_get_flags(req->rq_reqmsg),
153 ev->mlength, ev->offset, req->rq_replen);
156 req->rq_import->imp_last_reply_time = cfs_time_current_sec();
159 /* NB don't unlock till after wakeup; req can disappear under us
160 * since we don't have our own ref */
161 ptlrpc_client_wake_req(req);
162 spin_unlock(&req->rq_lock);
167 * Client's bulk has been written/read
169 void client_bulk_callback (lnet_event_t *ev)
171 struct ptlrpc_cb_id *cbid = ev->md.user_ptr;
172 struct ptlrpc_bulk_desc *desc = cbid->cbid_arg;
175 LASSERT ((desc->bd_type == BULK_PUT_SINK &&
176 ev->type == LNET_EVENT_PUT) ||
177 (desc->bd_type == BULK_GET_SOURCE &&
178 ev->type == LNET_EVENT_GET) ||
179 ev->type == LNET_EVENT_UNLINK);
180 LASSERT (ev->unlinked);
182 CDEBUG((ev->status == 0) ? D_NET : D_ERROR,
183 "event type %d, status %d, desc %p\n",
184 ev->type, ev->status, desc);
186 spin_lock(&desc->bd_lock);
188 LASSERT(desc->bd_network_rw);
189 desc->bd_network_rw = 0;
191 if (ev->type != LNET_EVENT_UNLINK && ev->status == 0) {
192 desc->bd_success = 1;
193 desc->bd_nob_transferred = ev->mlength;
194 desc->bd_sender = ev->sender;
197 /* release the encrypted pages for write */
198 if (desc->bd_req->rq_bulk_write)
199 sptlrpc_enc_pool_put_pages(desc);
201 /* NB don't unlock till after wakeup; desc can disappear under us
203 ptlrpc_client_wake_req(desc->bd_req);
205 spin_unlock(&desc->bd_lock);
210 * Server's incoming request callback
212 void request_in_callback(lnet_event_t *ev)
214 struct ptlrpc_cb_id *cbid = ev->md.user_ptr;
215 struct ptlrpc_request_buffer_desc *rqbd = cbid->cbid_arg;
216 struct ptlrpc_service *service = rqbd->rqbd_service;
217 struct ptlrpc_request *req;
220 LASSERT (ev->type == LNET_EVENT_PUT ||
221 ev->type == LNET_EVENT_UNLINK);
222 LASSERT ((char *)ev->md.start >= rqbd->rqbd_buffer);
223 LASSERT ((char *)ev->md.start + ev->offset + ev->mlength <=
224 rqbd->rqbd_buffer + service->srv_buf_size);
226 CDEBUG((ev->status == 0) ? D_NET : D_ERROR,
227 "event type %d, status %d, service %s\n",
228 ev->type, ev->status, service->srv_name);
231 /* If this is the last request message to fit in the
232 * request buffer we can use the request object embedded in
233 * rqbd. Note that if we failed to allocate a request,
234 * we'd have to re-post the rqbd, which we can't do in this
236 req = &rqbd->rqbd_req;
237 memset(req, 0, sizeof (*req));
239 LASSERT (ev->type == LNET_EVENT_PUT);
240 if (ev->status != 0) {
241 /* We moaned above already... */
244 OBD_ALLOC_GFP(req, sizeof(*req), CFS_ALLOC_ATOMIC_TRY);
246 CERROR("Can't allocate incoming request descriptor: "
247 "Dropping %s RPC from %s\n",
249 libcfs_id2str(ev->initiator));
254 /* NB we ABSOLUTELY RELY on req being zeroed, so pointers are NULL,
255 * flags are reset and scalars are zero. We only set the message
256 * size to non-zero if this was a successful receive. */
257 req->rq_xid = ev->match_bits;
258 req->rq_reqbuf = ev->md.start + ev->offset;
259 if (ev->type == LNET_EVENT_PUT && ev->status == 0)
260 req->rq_reqdata_len = ev->mlength;
261 do_gettimeofday(&req->rq_arrival_time);
262 req->rq_peer = ev->initiator;
263 req->rq_self = ev->target.nid;
265 req->rq_phase = RQ_PHASE_NEW;
267 req->rq_uid = ev->uid;
269 spin_lock_init(&req->rq_lock);
270 CFS_INIT_LIST_HEAD(&req->rq_timed_list);
271 atomic_set(&req->rq_refcount, 1);
272 if (ev->type == LNET_EVENT_PUT)
273 CDEBUG(D_RPCTRACE, "incoming req@%p x"LPU64" msgsize %u\n",
274 req, req->rq_xid, ev->mlength);
276 CDEBUG(D_RPCTRACE, "peer: %s\n", libcfs_id2str(req->rq_peer));
278 spin_lock(&service->srv_lock);
280 req->rq_history_seq = service->srv_request_seq++;
281 list_add_tail(&req->rq_history_list, &service->srv_request_history);
284 service->srv_nrqbd_receiving--;
285 CDEBUG(D_INFO, "Buffer complete: %d buffers still posted\n",
286 service->srv_nrqbd_receiving);
288 /* Normally, don't complain about 0 buffers posted; LNET won't
289 * drop incoming reqs since we set the portal lazy */
290 if (test_req_buffer_pressure &&
291 ev->type != LNET_EVENT_UNLINK &&
292 service->srv_nrqbd_receiving == 0)
293 CWARN("All %s request buffers busy\n",
296 /* req takes over the network's ref on rqbd */
298 /* req takes a ref on rqbd */
299 rqbd->rqbd_refcount++;
302 list_add_tail(&req->rq_list, &service->srv_req_in_queue);
303 service->srv_n_queued_reqs++;
305 /* NB everything can disappear under us once the request
306 * has been queued and we unlock, so do the wake now... */
307 cfs_waitq_signal(&service->srv_waitq);
309 spin_unlock(&service->srv_lock);
314 * Server's outgoing reply callback
316 void reply_out_callback(lnet_event_t *ev)
318 struct ptlrpc_cb_id *cbid = ev->md.user_ptr;
319 struct ptlrpc_reply_state *rs = cbid->cbid_arg;
320 struct ptlrpc_service *svc = rs->rs_service;
323 LASSERT (ev->type == LNET_EVENT_SEND ||
324 ev->type == LNET_EVENT_ACK ||
325 ev->type == LNET_EVENT_UNLINK);
327 if (!rs->rs_difficult) {
328 /* 'Easy' replies have no further processing so I drop the
329 * net's ref on 'rs' */
330 LASSERT (ev->unlinked);
331 ptlrpc_rs_decref(rs);
332 atomic_dec (&svc->srv_outstanding_replies);
337 LASSERT (rs->rs_on_net);
340 /* Last network callback. The net's ref on 'rs' stays put
341 * until ptlrpc_handle_rs() is done with it */
342 spin_lock(&svc->srv_lock);
343 spin_lock(&rs->rs_lock);
345 if (!rs->rs_no_ack ||
346 rs->rs_transno <= rs->rs_export->exp_obd->obd_last_committed)
347 ptlrpc_schedule_difficult_reply (rs);
348 spin_unlock(&rs->rs_lock);
349 spin_unlock(&svc->srv_lock);
356 * Server's bulk completion callback
358 void server_bulk_callback (lnet_event_t *ev)
360 struct ptlrpc_cb_id *cbid = ev->md.user_ptr;
361 struct ptlrpc_bulk_desc *desc = cbid->cbid_arg;
364 LASSERT (ev->type == LNET_EVENT_SEND ||
365 ev->type == LNET_EVENT_UNLINK ||
366 (desc->bd_type == BULK_PUT_SOURCE &&
367 ev->type == LNET_EVENT_ACK) ||
368 (desc->bd_type == BULK_GET_SINK &&
369 ev->type == LNET_EVENT_REPLY));
371 CDEBUG((ev->status == 0) ? D_NET : D_ERROR,
372 "event type %d, status %d, desc %p\n",
373 ev->type, ev->status, desc);
375 spin_lock(&desc->bd_lock);
377 if ((ev->type == LNET_EVENT_ACK ||
378 ev->type == LNET_EVENT_REPLY) &&
380 /* We heard back from the peer, so even if we get this
381 * before the SENT event (oh yes we can), we know we
382 * read/wrote the peer buffer and how much... */
383 desc->bd_success = 1;
384 desc->bd_nob_transferred = ev->mlength;
385 desc->bd_sender = ev->sender;
389 /* This is the last callback no matter what... */
390 desc->bd_network_rw = 0;
391 cfs_waitq_signal(&desc->bd_waitq);
394 spin_unlock(&desc->bd_lock);
398 static void ptlrpc_master_callback(lnet_event_t *ev)
400 struct ptlrpc_cb_id *cbid = ev->md.user_ptr;
401 void (*callback)(lnet_event_t *ev) = cbid->cbid_fn;
403 /* Honestly, it's best to find out early. */
404 LASSERT (cbid->cbid_arg != LP_POISON);
405 LASSERT (callback == request_out_callback ||
406 callback == reply_in_callback ||
407 callback == client_bulk_callback ||
408 callback == request_in_callback ||
409 callback == reply_out_callback ||
410 callback == server_bulk_callback);
415 int ptlrpc_uuid_to_peer (struct obd_uuid *uuid,
416 lnet_process_id_t *peer, lnet_nid_t *self)
419 __u32 best_order = 0;
422 int portals_compatibility;
428 portals_compatibility = LNetCtl(IOC_LIBCFS_PORTALS_COMPATIBILITY, NULL);
430 peer->pid = LUSTRE_SRV_LNET_PID;
432 /* Choose the matching UUID that's closest */
433 while (lustre_uuid_to_peer(uuid->uuid, &dst_nid, count++) == 0) {
434 dist = LNetDist(dst_nid, &src_nid, &order);
438 if (dist == 0) { /* local! use loopback LND */
439 peer->nid = *self = LNET_MKNID(LNET_MKNET(LOLND, 0), 0);
446 (dist == best_dist && order < best_order)) {
450 if (portals_compatibility > 1) {
451 /* Strong portals compatibility: Zero the nid's
452 * NET, so if I'm reading new config logs, or
453 * getting configured by (new) lconf I can
454 * still talk to old servers. */
455 dst_nid = LNET_MKNID(0, LNET_NIDADDR(dst_nid));
456 src_nid = LNET_MKNID(0, LNET_NIDADDR(src_nid));
464 CDEBUG(D_NET,"%s->%s\n", uuid->uuid, libcfs_id2str(*peer));
466 CERROR("No NID found for %s\n", uuid->uuid);
470 void ptlrpc_ni_fini(void)
473 struct l_wait_info lwi;
477 /* Wait for the event queue to become idle since there may still be
478 * messages in flight with pending events (i.e. the fire-and-forget
479 * messages == client requests and "non-difficult" server
482 for (retries = 0;; retries++) {
483 rc = LNetEQFree(ptlrpc_eq_h);
494 CWARN("Event queue still busy\n");
497 cfs_waitq_init(&waitq);
498 lwi = LWI_TIMEOUT(cfs_time_seconds(2), NULL, NULL);
499 l_wait_event(waitq, 0, &lwi);
506 lnet_pid_t ptl_get_pid(void)
513 pid = LUSTRE_SRV_LNET_PID;
518 int ptlrpc_ni_init(void)
524 CDEBUG(D_NET, "My pid is: %x\n", pid);
526 /* We're not passing any limits yet... */
527 rc = LNetNIInit(pid);
529 CDEBUG (D_NET, "Can't init network interface: %d\n", rc);
533 /* CAVEAT EMPTOR: how we process portals events is _radically_
534 * different depending on... */
536 /* kernel portals calls our master callback when events are added to
537 * the event queue. In fact lustre never pulls events off this queue,
538 * so it's only sized for some debug history. */
539 rc = LNetEQAlloc(1024, ptlrpc_master_callback, &ptlrpc_eq_h);
541 /* liblustre calls the master callback when it removes events from the
542 * event queue. The event queue has to be big enough not to drop
544 rc = LNetEQAlloc(10240, LNET_EQ_HANDLER_NONE, &ptlrpc_eq_h);
549 CERROR ("Failed to allocate event queue: %d\n", rc);
556 CFS_LIST_HEAD(liblustre_wait_callbacks);
557 CFS_LIST_HEAD(liblustre_idle_callbacks);
558 void *liblustre_services_callback;
561 liblustre_register_waitidle_callback (struct list_head *callback_list,
563 int (*fn)(void *arg), void *arg)
565 struct liblustre_wait_callback *llwc;
567 OBD_ALLOC(llwc, sizeof(*llwc));
568 LASSERT (llwc != NULL);
570 llwc->llwc_name = name;
572 llwc->llwc_arg = arg;
573 list_add_tail(&llwc->llwc_list, callback_list);
579 liblustre_deregister_waitidle_callback (void *opaque)
581 struct liblustre_wait_callback *llwc = opaque;
583 list_del(&llwc->llwc_list);
584 OBD_FREE(llwc, sizeof(*llwc));
588 liblustre_register_wait_callback (const char *name,
589 int (*fn)(void *arg), void *arg)
591 return liblustre_register_waitidle_callback(&liblustre_wait_callbacks,
596 liblustre_deregister_wait_callback (void *opaque)
598 liblustre_deregister_waitidle_callback(opaque);
602 liblustre_register_idle_callback (const char *name,
603 int (*fn)(void *arg), void *arg)
605 return liblustre_register_waitidle_callback(&liblustre_idle_callbacks,
610 liblustre_deregister_idle_callback (void *opaque)
612 liblustre_deregister_waitidle_callback(opaque);
616 liblustre_check_events (int timeout)
623 rc = LNetEQPoll(&ptlrpc_eq_h, 1, timeout * 1000, &ev, &i);
627 LASSERT (rc == -EOVERFLOW || rc == 1);
629 /* liblustre: no asynch callback so we can't afford to miss any
631 if (rc == -EOVERFLOW) {
632 CERROR ("Dropped an event!!!\n");
636 ptlrpc_master_callback (&ev);
640 int liblustre_waiting = 0;
643 liblustre_wait_event (int timeout)
645 struct list_head *tmp;
646 struct liblustre_wait_callback *llwc;
647 int found_something = 0;
649 /* single threaded recursion check... */
650 liblustre_waiting = 1;
653 /* Deal with all pending events */
654 while (liblustre_check_events(0))
657 /* Give all registered callbacks a bite at the cherry */
658 list_for_each(tmp, &liblustre_wait_callbacks) {
659 llwc = list_entry(tmp, struct liblustre_wait_callback,
662 if (llwc->llwc_fn(llwc->llwc_arg))
666 if (found_something || timeout == 0)
669 /* Nothing so far, but I'm allowed to block... */
670 found_something = liblustre_check_events(timeout);
671 if (!found_something) /* still nothing */
672 break; /* I timed out */
675 liblustre_waiting = 0;
677 return found_something;
681 liblustre_wait_idle(void)
683 static int recursed = 0;
685 struct list_head *tmp;
686 struct liblustre_wait_callback *llwc;
693 liblustre_wait_event(0);
697 list_for_each(tmp, &liblustre_idle_callbacks) {
698 llwc = list_entry(tmp, struct liblustre_wait_callback,
701 if (!llwc->llwc_fn(llwc->llwc_arg)) {
712 #endif /* __KERNEL__ */
714 int ptlrpc_init_portals(void)
716 int rc = ptlrpc_ni_init();
719 CERROR("network initialisation failed\n");
723 liblustre_services_callback =
724 liblustre_register_wait_callback("liblustre_check_services",
725 &liblustre_check_services,
727 init_completion_module(liblustre_wait_event);
729 rc = ptlrpcd_addref();
733 CERROR("rpcd initialisation failed\n");
735 liblustre_deregister_wait_callback(liblustre_services_callback);
741 void ptlrpc_exit_portals(void)
744 liblustre_deregister_wait_callback(liblustre_services_callback);