4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2012, 2016, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
33 #define DEBUG_SUBSYSTEM S_RPC
35 #include <libcfs/libcfs.h>
36 #include <linux/kernel.h>
37 #include <obd_class.h>
38 #include <lustre_net.h>
39 #include <lustre_sec.h>
40 #include "ptlrpc_internal.h"
42 struct lnet_handle_eq ptlrpc_eq_h;
45 * Client's outgoing request callback
47 void request_out_callback(struct lnet_event *ev)
49 struct ptlrpc_cb_id *cbid = ev->md.user_ptr;
50 struct ptlrpc_request *req = cbid->cbid_arg;
54 LASSERT(ev->type == LNET_EVENT_SEND || ev->type == LNET_EVENT_UNLINK);
55 LASSERT(ev->unlinked);
57 DEBUG_REQ(D_NET, req, "type %d, status %d", ev->type, ev->status);
59 sptlrpc_request_out_callback(req);
61 spin_lock(&req->rq_lock);
62 req->rq_real_sent = ktime_get_real_seconds();
63 req->rq_req_unlinked = 1;
64 /* reply_in_callback happened before request_out_callback? */
65 if (req->rq_reply_unlinked)
68 if (ev->type == LNET_EVENT_UNLINK || ev->status != 0) {
69 /* Failed send: make it seem like the reply timed out, just
70 * like failing sends in client.c does currently... */
76 ptlrpc_client_wake_req(req);
78 spin_unlock(&req->rq_lock);
80 ptlrpc_req_finished(req);
85 * Client's incoming reply callback
87 void reply_in_callback(struct lnet_event *ev)
89 struct ptlrpc_cb_id *cbid = ev->md.user_ptr;
90 struct ptlrpc_request *req = cbid->cbid_arg;
93 DEBUG_REQ(D_NET, req, "type %d, status %d", ev->type, ev->status);
95 LASSERT (ev->type == LNET_EVENT_PUT || ev->type == LNET_EVENT_UNLINK);
96 LASSERT (ev->md.start == req->rq_repbuf);
97 LASSERT (ev->offset + ev->mlength <= req->rq_repbuf_len);
98 /* We've set LNET_MD_MANAGE_REMOTE for all outgoing requests
99 for adaptive timeouts' early reply. */
100 LASSERT((ev->md.options & LNET_MD_MANAGE_REMOTE) != 0);
102 spin_lock(&req->rq_lock);
104 req->rq_receiving_reply = 0;
107 req->rq_reply_unlinked = 1;
112 if (ev->type == LNET_EVENT_UNLINK) {
113 LASSERT(ev->unlinked);
114 DEBUG_REQ(D_NET, req, "unlink");
118 if (ev->mlength < ev->rlength ) {
119 CDEBUG(D_RPCTRACE, "truncate req %p rpc %d - %d+%d\n", req,
120 req->rq_replen, ev->rlength, ev->offset);
121 req->rq_reply_truncated = 1;
123 req->rq_status = -EOVERFLOW;
124 req->rq_nob_received = ev->rlength + ev->offset;
128 if ((ev->offset == 0) &&
129 ((lustre_msghdr_get_flags(req->rq_reqmsg) & MSGHDR_AT_SUPPORT))) {
131 DEBUG_REQ(D_ADAPTTO, req,
132 "Early reply received: mlen=%u offset=%d replen=%d "
133 "replied=%d unlinked=%d", ev->mlength, ev->offset,
134 req->rq_replen, req->rq_replied, ev->unlinked);
136 req->rq_early_count++; /* number received, client side */
138 /* already got the real reply or buffers are already unlinked */
139 if (req->rq_replied ||
140 req->rq_reply_unlinked == 1)
144 req->rq_reply_off = ev->offset;
145 req->rq_nob_received = ev->mlength;
146 /* And we're still receiving */
147 req->rq_receiving_reply = 1;
150 req->rq_rep_swab_mask = 0;
152 /* Got reply, no resend required */
154 req->rq_reply_off = ev->offset;
155 req->rq_nob_received = ev->mlength;
156 /* LNetMDUnlink can't be called under the LNET_LOCK,
157 so we must unlink in ptlrpc_unregister_reply */
158 DEBUG_REQ(D_INFO, req,
159 "reply in flags=%x mlen=%u offset=%d replen=%d",
160 lustre_msg_get_flags(req->rq_reqmsg),
161 ev->mlength, ev->offset, req->rq_replen);
164 req->rq_import->imp_last_reply_time = ktime_get_real_seconds();
167 /* NB don't unlock till after wakeup; req can disappear under us
168 * since we don't have our own ref */
169 ptlrpc_client_wake_req(req);
170 spin_unlock(&req->rq_lock);
175 * Client's bulk has been written/read
177 void client_bulk_callback(struct lnet_event *ev)
179 struct ptlrpc_cb_id *cbid = ev->md.user_ptr;
180 struct ptlrpc_bulk_desc *desc = cbid->cbid_arg;
181 struct ptlrpc_request *req;
184 LASSERT((ptlrpc_is_bulk_put_sink(desc->bd_type) &&
185 ev->type == LNET_EVENT_PUT) ||
186 (ptlrpc_is_bulk_get_source(desc->bd_type) &&
187 ev->type == LNET_EVENT_GET) ||
188 ev->type == LNET_EVENT_UNLINK);
189 LASSERT(ev->unlinked);
191 if (CFS_FAIL_CHECK_ORSET(OBD_FAIL_PTLRPC_CLIENT_BULK_CB, CFS_FAIL_ONCE))
194 if (CFS_FAIL_CHECK_ORSET(OBD_FAIL_PTLRPC_CLIENT_BULK_CB2,CFS_FAIL_ONCE))
197 CDEBUG((ev->status == 0) ? D_NET : D_ERROR,
198 "event type %d, status %d, desc %p\n",
199 ev->type, ev->status, desc);
201 spin_lock(&desc->bd_lock);
203 LASSERT(desc->bd_md_count > 0);
206 if (ev->type != LNET_EVENT_UNLINK && ev->status == 0) {
207 desc->bd_nob_transferred += ev->mlength;
208 desc->bd_sender = ev->sender;
210 /* start reconnect and resend if network error hit */
211 spin_lock(&req->rq_lock);
213 spin_unlock(&req->rq_lock);
217 desc->bd_failure = 1;
219 /* NB don't unlock till after wakeup; desc can disappear under us
221 if (desc->bd_md_count == 0)
222 ptlrpc_client_wake_req(desc->bd_req);
224 spin_unlock(&desc->bd_lock);
229 * We will have percpt request history list for ptlrpc service in upcoming
230 * patches because we don't want to be serialized by current per-service
231 * history operations. So we require history ID can (somehow) show arriving
232 * order w/o grabbing global lock, and user can sort them in userspace.
234 * This is how we generate history ID for ptlrpc_request:
235 * ----------------------------------------------------
236 * | 32 bits | 16 bits | (16 - X)bits | X bits |
237 * ----------------------------------------------------
238 * | seconds | usec / 16 | sequence | CPT id |
239 * ----------------------------------------------------
241 * it might not be precise but should be good enough.
244 #define REQS_CPT_BITS(svcpt) ((svcpt)->scp_service->srv_cpt_bits)
246 #define REQS_SEC_SHIFT 32
247 #define REQS_USEC_SHIFT 16
248 #define REQS_SEQ_SHIFT(svcpt) REQS_CPT_BITS(svcpt)
250 static void ptlrpc_req_add_history(struct ptlrpc_service_part *svcpt,
251 struct ptlrpc_request *req)
253 u64 sec = req->rq_arrival_time.tv_sec;
254 u32 usec = req->rq_arrival_time.tv_nsec / NSEC_PER_USEC / 16; /* usec / 16 */
257 /* set sequence ID for request and add it to history list,
258 * it must be called with hold svcpt::scp_lock */
260 new_seq = (sec << REQS_SEC_SHIFT) |
261 (usec << REQS_USEC_SHIFT) |
262 (svcpt->scp_cpt < 0 ? 0 : svcpt->scp_cpt);
264 if (new_seq > svcpt->scp_hist_seq) {
265 /* This handles the initial case of scp_hist_seq == 0 or
266 * we just jumped into a new time window */
267 svcpt->scp_hist_seq = new_seq;
269 LASSERT(REQS_SEQ_SHIFT(svcpt) < REQS_USEC_SHIFT);
270 /* NB: increase sequence number in current usec bucket,
271 * however, it's possible that we used up all bits for
272 * sequence and jumped into the next usec bucket (future time),
273 * then we hope there will be less RPCs per bucket at some
274 * point, and sequence will catch up again */
275 svcpt->scp_hist_seq += (1U << REQS_SEQ_SHIFT(svcpt));
276 new_seq = svcpt->scp_hist_seq;
279 req->rq_history_seq = new_seq;
281 list_add_tail(&req->rq_history_list, &svcpt->scp_hist_reqs);
285 * Server's incoming request callback
287 void request_in_callback(struct lnet_event *ev)
289 struct ptlrpc_cb_id *cbid = ev->md.user_ptr;
290 struct ptlrpc_request_buffer_desc *rqbd = cbid->cbid_arg;
291 struct ptlrpc_service_part *svcpt = rqbd->rqbd_svcpt;
292 struct ptlrpc_service *service = svcpt->scp_service;
293 struct ptlrpc_request *req;
296 LASSERT (ev->type == LNET_EVENT_PUT ||
297 ev->type == LNET_EVENT_UNLINK);
298 LASSERT ((char *)ev->md.start >= rqbd->rqbd_buffer);
299 LASSERT ((char *)ev->md.start + ev->offset + ev->mlength <=
300 rqbd->rqbd_buffer + service->srv_buf_size);
302 CDEBUG((ev->status == 0) ? D_NET : D_ERROR,
303 "event type %d, status %d, service %s\n",
304 ev->type, ev->status, service->srv_name);
307 /* If this is the last request message to fit in the
308 * request buffer we can use the request object embedded in
309 * rqbd. Note that if we failed to allocate a request,
310 * we'd have to re-post the rqbd, which we can't do in this
312 req = &rqbd->rqbd_req;
313 memset(req, 0, sizeof (*req));
315 LASSERT (ev->type == LNET_EVENT_PUT);
316 if (ev->status != 0) {
317 /* We moaned above already... */
320 req = ptlrpc_request_cache_alloc(GFP_ATOMIC);
322 CERROR("Can't allocate incoming request descriptor: "
323 "Dropping %s RPC from %s\n",
325 libcfs_id2str(ev->initiator));
330 ptlrpc_srv_req_init(req);
331 /* NB we ABSOLUTELY RELY on req being zeroed, so pointers are NULL,
332 * flags are reset and scalars are zero. We only set the message
333 * size to non-zero if this was a successful receive. */
334 req->rq_xid = ev->match_bits;
335 req->rq_reqbuf = ev->md.start + ev->offset;
336 if (ev->type == LNET_EVENT_PUT && ev->status == 0)
337 req->rq_reqdata_len = ev->mlength;
338 ktime_get_real_ts64(&req->rq_arrival_time);
339 /* Multi-Rail: keep track of both initiator and source NID. */
340 req->rq_peer = ev->initiator;
341 req->rq_source = ev->source;
342 req->rq_self = ev->target.nid;
344 req->rq_phase = RQ_PHASE_NEW;
345 if (ev->type == LNET_EVENT_PUT)
346 CDEBUG(D_INFO, "incoming req@%p x%llu msgsize %u\n",
347 req, req->rq_xid, ev->mlength);
349 CDEBUG(D_RPCTRACE, "peer: %s (source: %s)\n",
350 libcfs_id2str(req->rq_peer), libcfs_id2str(req->rq_source));
352 spin_lock(&svcpt->scp_lock);
354 ptlrpc_req_add_history(svcpt, req);
357 svcpt->scp_nrqbds_posted--;
358 CDEBUG(D_INFO, "Buffer complete: %d buffers still posted\n",
359 svcpt->scp_nrqbds_posted);
361 /* Normally, don't complain about 0 buffers posted; LNET won't
362 * drop incoming reqs since we set the portal lazy */
363 if (test_req_buffer_pressure &&
364 ev->type != LNET_EVENT_UNLINK &&
365 svcpt->scp_nrqbds_posted == 0)
366 CWARN("All %s request buffers busy\n",
369 /* req takes over the network's ref on rqbd */
371 /* req takes a ref on rqbd */
372 rqbd->rqbd_refcount++;
375 list_add_tail(&req->rq_list, &svcpt->scp_req_incoming);
376 svcpt->scp_nreqs_incoming++;
378 /* NB everything can disappear under us once the request
379 * has been queued and we unlock, so do the wake now... */
380 wake_up(&svcpt->scp_waitq);
382 spin_unlock(&svcpt->scp_lock);
387 * Server's outgoing reply callback
389 void reply_out_callback(struct lnet_event *ev)
391 struct ptlrpc_cb_id *cbid = ev->md.user_ptr;
392 struct ptlrpc_reply_state *rs = cbid->cbid_arg;
393 struct ptlrpc_service_part *svcpt = rs->rs_svcpt;
396 LASSERT (ev->type == LNET_EVENT_SEND ||
397 ev->type == LNET_EVENT_ACK ||
398 ev->type == LNET_EVENT_UNLINK);
400 if (!rs->rs_difficult) {
401 /* 'Easy' replies have no further processing so I drop the
402 * net's ref on 'rs' */
403 LASSERT (ev->unlinked);
404 ptlrpc_rs_decref(rs);
409 LASSERT (rs->rs_on_net);
412 /* Last network callback. The net's ref on 'rs' stays put
413 * until ptlrpc_handle_rs() is done with it */
414 spin_lock(&svcpt->scp_rep_lock);
415 spin_lock(&rs->rs_lock);
418 if (!rs->rs_no_ack ||
420 rs->rs_export->exp_obd->obd_last_committed ||
421 list_empty(&rs->rs_obd_list))
422 ptlrpc_schedule_difficult_reply(rs);
424 spin_unlock(&rs->rs_lock);
425 spin_unlock(&svcpt->scp_rep_lock);
430 #ifdef HAVE_SERVER_SUPPORT
432 * Server's bulk completion callback
434 void server_bulk_callback(struct lnet_event *ev)
436 struct ptlrpc_cb_id *cbid = ev->md.user_ptr;
437 struct ptlrpc_bulk_desc *desc = cbid->cbid_arg;
440 LASSERT(ev->type == LNET_EVENT_SEND ||
441 ev->type == LNET_EVENT_UNLINK ||
442 (ptlrpc_is_bulk_put_source(desc->bd_type) &&
443 ev->type == LNET_EVENT_ACK) ||
444 (ptlrpc_is_bulk_get_sink(desc->bd_type) &&
445 ev->type == LNET_EVENT_REPLY));
447 CDEBUG((ev->status == 0) ? D_NET : D_ERROR,
448 "event type %d, status %d, desc %p\n",
449 ev->type, ev->status, desc);
451 spin_lock(&desc->bd_lock);
453 LASSERT(desc->bd_md_count > 0);
455 if ((ev->type == LNET_EVENT_ACK ||
456 ev->type == LNET_EVENT_REPLY) &&
458 /* We heard back from the peer, so even if we get this
459 * before the SENT event (oh yes we can), we know we
460 * read/wrote the peer buffer and how much... */
461 desc->bd_nob_transferred += ev->mlength;
462 desc->bd_sender = ev->sender;
466 desc->bd_failure = 1;
470 /* This is the last callback no matter what... */
471 if (desc->bd_md_count == 0)
472 wake_up(&desc->bd_waitq);
475 spin_unlock(&desc->bd_lock);
480 static void ptlrpc_master_callback(struct lnet_event *ev)
482 struct ptlrpc_cb_id *cbid = ev->md.user_ptr;
483 void (*callback)(struct lnet_event *ev) = cbid->cbid_fn;
485 /* Honestly, it's best to find out early. */
486 LASSERT (cbid->cbid_arg != LP_POISON);
487 LASSERT (callback == request_out_callback ||
488 callback == reply_in_callback ||
489 callback == client_bulk_callback ||
490 callback == request_in_callback ||
491 callback == reply_out_callback
492 #ifdef HAVE_SERVER_SUPPORT
493 || callback == server_bulk_callback
500 int ptlrpc_uuid_to_peer(struct obd_uuid *uuid,
501 struct lnet_process_id *peer, lnet_nid_t *self)
504 __u32 best_order = 0;
512 peer->pid = LNET_PID_LUSTRE;
514 /* Choose the matching UUID that's closest */
515 while (lustre_uuid_to_peer(uuid->uuid, &dst_nid, count++) == 0) {
516 if (peer->nid != LNET_NID_ANY && LNET_NIDADDR(peer->nid) == 0 &&
517 LNET_NIDNET(dst_nid) != LNET_NIDNET(peer->nid))
520 dist = LNetDist(dst_nid, &src_nid, &order);
524 if (dist == 0) { /* local! use loopback LND */
525 peer->nid = *self = LNET_MKNID(LNET_MKNET(LOLND, 0), 0);
532 (dist == best_dist && order < best_order)) {
542 CDEBUG(D_NET, "%s->%s\n", uuid->uuid, libcfs_id2str(*peer));
546 void ptlrpc_ni_fini(void)
548 wait_queue_head_t waitq;
549 struct l_wait_info lwi;
553 /* Wait for the event queue to become idle since there may still be
554 * messages in flight with pending events (i.e. the fire-and-forget
555 * messages == client requests and "non-difficult" server
558 for (retries = 0;; retries++) {
559 rc = LNetEQFree(ptlrpc_eq_h);
570 CWARN("Event queue still busy\n");
573 init_waitqueue_head(&waitq);
574 lwi = LWI_TIMEOUT(cfs_time_seconds(2), NULL, NULL);
575 l_wait_event(waitq, 0, &lwi);
582 lnet_pid_t ptl_get_pid(void)
584 return LNET_PID_LUSTRE;
587 int ptlrpc_ni_init(void)
593 CDEBUG(D_NET, "My pid is: %x\n", pid);
595 /* We're not passing any limits yet... */
596 rc = LNetNIInit(pid);
598 CDEBUG (D_NET, "Can't init network interface: %d\n", rc);
602 /* CAVEAT EMPTOR: how we process portals events is _radically_
603 * different depending on... */
604 /* kernel LNet calls our master callback when there are new event,
605 * because we are guaranteed to get every event via callback,
606 * so we just set EQ size to 0 to avoid overhread of serializing
607 * enqueue/dequeue operations in LNet. */
608 rc = LNetEQAlloc(0, ptlrpc_master_callback, &ptlrpc_eq_h);
612 CERROR ("Failed to allocate event queue: %d\n", rc);
619 int ptlrpc_init_portals(void)
621 int rc = ptlrpc_ni_init();
624 CERROR("network initialisation failed\n");
627 rc = ptlrpcd_addref();
631 CERROR("rpcd initialisation failed\n");
636 void ptlrpc_exit_portals(void)