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, 2017, 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 <linux/delay.h>
38 #include <obd_class.h>
39 #include <lustre_net.h>
40 #include <lustre_sec.h>
41 #include "ptlrpc_internal.h"
43 lnet_handler_t ptlrpc_handler;
44 struct percpu_ref ptlrpc_pending;
47 * Client's outgoing request callback
49 void request_out_callback(struct lnet_event *ev)
51 struct ptlrpc_cb_id *cbid = ev->md_user_ptr;
52 struct ptlrpc_request *req = cbid->cbid_arg;
56 LASSERT(ev->type == LNET_EVENT_SEND || ev->type == LNET_EVENT_UNLINK);
57 LASSERT(ev->unlinked);
59 DEBUG_REQ(D_NET, req, "type %d, status %d", ev->type, ev->status);
61 sptlrpc_request_out_callback(req);
63 spin_lock(&req->rq_lock);
64 req->rq_real_sent = ktime_get_real_seconds();
65 req->rq_req_unlinked = 1;
66 /* reply_in_callback happened before request_out_callback? */
67 if (req->rq_reply_unlinked)
70 if (ev->type == LNET_EVENT_UNLINK || ev->status != 0) {
71 /* Failed send: make it seem like the reply timed out, just
72 * like failing sends in client.c does currently... */
78 ptlrpc_client_wake_req(req);
80 spin_unlock(&req->rq_lock);
82 ptlrpc_req_finished(req);
87 * Client's incoming reply callback
89 void reply_in_callback(struct lnet_event *ev)
91 struct ptlrpc_cb_id *cbid = ev->md_user_ptr;
92 struct ptlrpc_request *req = cbid->cbid_arg;
95 DEBUG_REQ(D_NET, req, "type %d, status %d", ev->type, ev->status);
97 LASSERT(ev->type == LNET_EVENT_PUT || ev->type == LNET_EVENT_UNLINK);
98 LASSERT(ev->md_start == req->rq_repbuf);
99 LASSERT(ev->offset + ev->mlength <= req->rq_repbuf_len);
100 /* We've set LNET_MD_MANAGE_REMOTE for all outgoing requests
101 * for adaptive timeouts' early reply.
103 LASSERT((ev->md_options & LNET_MD_MANAGE_REMOTE) != 0);
105 spin_lock(&req->rq_lock);
107 req->rq_receiving_reply = 0;
110 req->rq_reply_unlinked = 1;
115 if (ev->type == LNET_EVENT_UNLINK) {
116 LASSERT(ev->unlinked);
117 DEBUG_REQ(D_NET, req, "unlink");
121 if (ev->mlength < ev->rlength ) {
122 CDEBUG(D_RPCTRACE, "truncate req %p rpc %d - %d+%d\n", req,
123 req->rq_replen, ev->rlength, ev->offset);
124 req->rq_reply_truncated = 1;
126 req->rq_status = -EOVERFLOW;
127 req->rq_nob_received = ev->rlength + ev->offset;
131 if ((ev->offset == 0) &&
132 ((lustre_msghdr_get_flags(req->rq_reqmsg) & MSGHDR_AT_SUPPORT))) {
134 DEBUG_REQ(D_ADAPTTO, req,
135 "Early reply received, mlen=%u offset=%d replen=%d replied=%d unlinked=%d",
136 ev->mlength, ev->offset,
137 req->rq_replen, req->rq_replied, ev->unlinked);
139 req->rq_early_count++; /* number received, client side */
141 /* already got the real reply or buffers are already unlinked */
142 if (req->rq_replied ||
143 req->rq_reply_unlinked == 1)
147 req->rq_reply_off = ev->offset;
148 req->rq_nob_received = ev->mlength;
149 /* And we're still receiving */
150 req->rq_receiving_reply = 1;
153 req->rq_rep_swab_mask = 0;
155 /* Got reply, no resend required */
157 req->rq_reply_off = ev->offset;
158 req->rq_nob_received = ev->mlength;
159 /* LNetMDUnlink can't be called under the LNET_LOCK,
160 so we must unlink in ptlrpc_unregister_reply */
161 DEBUG_REQ(D_INFO, req,
162 "reply in flags=%x mlen=%u offset=%d replen=%d",
163 lustre_msg_get_flags(req->rq_reqmsg),
164 ev->mlength, ev->offset, req->rq_replen);
167 if (lustre_msg_get_opc(req->rq_reqmsg) != OBD_PING)
168 req->rq_import->imp_last_reply_time = ktime_get_real_seconds();
171 /* NB don't unlock till after wakeup; req can disappear under us
172 * since we don't have our own ref */
173 ptlrpc_client_wake_req(req);
174 spin_unlock(&req->rq_lock);
179 * Client's bulk has been written/read
181 void client_bulk_callback(struct lnet_event *ev)
183 struct ptlrpc_cb_id *cbid = ev->md_user_ptr;
184 struct ptlrpc_bulk_desc *desc = cbid->cbid_arg;
185 struct ptlrpc_request *req;
188 LASSERT((ptlrpc_is_bulk_put_sink(desc->bd_type) &&
189 ev->type == LNET_EVENT_PUT) ||
190 (ptlrpc_is_bulk_get_source(desc->bd_type) &&
191 ev->type == LNET_EVENT_GET) ||
192 ev->type == LNET_EVENT_UNLINK);
193 LASSERT(ev->unlinked);
195 if (CFS_FAIL_CHECK_ORSET(OBD_FAIL_PTLRPC_CLIENT_BULK_CB, CFS_FAIL_ONCE))
198 if (CFS_FAIL_CHECK_ORSET(OBD_FAIL_PTLRPC_CLIENT_BULK_CB2,CFS_FAIL_ONCE))
201 CDEBUG((ev->status == 0) ? D_NET : D_ERROR,
202 "event type %d, status %d, desc %p\n",
203 ev->type, ev->status, desc);
205 spin_lock(&desc->bd_lock);
207 LASSERT(desc->bd_refs > 0);
210 if (ev->type != LNET_EVENT_UNLINK && ev->status == 0) {
211 desc->bd_nob_transferred += ev->mlength;
212 desc->bd_sender = ev->sender;
214 /* start reconnect and resend if network error hit */
215 spin_lock(&req->rq_lock);
217 spin_unlock(&req->rq_lock);
221 desc->bd_failure = 1;
223 /* NB don't unlock till after wakeup; desc can disappear under us
225 if (desc->bd_refs == 0)
226 ptlrpc_client_wake_req(desc->bd_req);
228 spin_unlock(&desc->bd_lock);
233 * We will have percpt request history list for ptlrpc service in upcoming
234 * patches because we don't want to be serialized by current per-service
235 * history operations. So we require history ID can (somehow) show arriving
236 * order w/o grabbing global lock, and user can sort them in userspace.
238 * This is how we generate history ID for ptlrpc_request:
239 * ----------------------------------------------------
240 * | 32 bits | 16 bits | (16 - X)bits | X bits |
241 * ----------------------------------------------------
242 * | seconds | usec / 16 | sequence | CPT id |
243 * ----------------------------------------------------
245 * it might not be precise but should be good enough.
248 #define REQS_CPT_BITS(svcpt) ((svcpt)->scp_service->srv_cpt_bits)
250 #define REQS_SEC_SHIFT 32
251 #define REQS_USEC_SHIFT 16
252 #define REQS_SEQ_SHIFT(svcpt) REQS_CPT_BITS(svcpt)
254 static void ptlrpc_req_add_history(struct ptlrpc_service_part *svcpt,
255 struct ptlrpc_request *req)
257 u64 sec = req->rq_arrival_time.tv_sec;
258 u32 usec = req->rq_arrival_time.tv_nsec / NSEC_PER_USEC / 16; /* usec / 16 */
261 /* set sequence ID for request and add it to history list,
262 * it must be called with hold svcpt::scp_lock */
264 new_seq = (sec << REQS_SEC_SHIFT) |
265 (usec << REQS_USEC_SHIFT) |
266 (svcpt->scp_cpt < 0 ? 0 : svcpt->scp_cpt);
268 if (new_seq > svcpt->scp_hist_seq) {
269 /* This handles the initial case of scp_hist_seq == 0 or
270 * we just jumped into a new time window */
271 svcpt->scp_hist_seq = new_seq;
273 LASSERT(REQS_SEQ_SHIFT(svcpt) < REQS_USEC_SHIFT);
274 /* NB: increase sequence number in current usec bucket,
275 * however, it's possible that we used up all bits for
276 * sequence and jumped into the next usec bucket (future time),
277 * then we hope there will be less RPCs per bucket at some
278 * point, and sequence will catch up again */
279 svcpt->scp_hist_seq += (1U << REQS_SEQ_SHIFT(svcpt));
280 new_seq = svcpt->scp_hist_seq;
283 req->rq_history_seq = new_seq;
285 list_add_tail(&req->rq_history_list, &svcpt->scp_hist_reqs);
289 * Server's incoming request callback
291 void request_in_callback(struct lnet_event *ev)
293 struct ptlrpc_cb_id *cbid = ev->md_user_ptr;
294 struct ptlrpc_request_buffer_desc *rqbd = cbid->cbid_arg;
295 struct ptlrpc_service_part *svcpt = rqbd->rqbd_svcpt;
296 struct ptlrpc_service *service = svcpt->scp_service;
297 struct ptlrpc_request *req;
300 LASSERT(ev->type == LNET_EVENT_PUT ||
301 ev->type == LNET_EVENT_UNLINK);
302 LASSERT((char *)ev->md_start >= rqbd->rqbd_buffer);
303 LASSERT((char *)ev->md_start + ev->offset + ev->mlength <=
304 rqbd->rqbd_buffer + service->srv_buf_size);
306 CDEBUG((ev->status == 0) ? D_NET : D_ERROR,
307 "event type %d, status %d, service %s\n",
308 ev->type, ev->status, service->srv_name);
311 /* If this is the last request message to fit in the
312 * request buffer we can use the request object embedded in
313 * rqbd. Note that if we failed to allocate a request,
314 * we'd have to re-post the rqbd, which we can't do in this
316 req = &rqbd->rqbd_req;
317 memset(req, 0, sizeof (*req));
319 LASSERT (ev->type == LNET_EVENT_PUT);
320 if (ev->status != 0) {
321 /* We moaned above already... */
324 req = ptlrpc_request_cache_alloc(GFP_ATOMIC);
326 CERROR("Can't allocate incoming request descriptor: "
327 "Dropping %s RPC from %s\n",
329 libcfs_id2str(ev->initiator));
334 ptlrpc_srv_req_init(req);
335 /* NB we ABSOLUTELY RELY on req being zeroed, so pointers are NULL,
336 * flags are reset and scalars are zero. We only set the message
337 * size to non-zero if this was a successful receive. */
338 req->rq_xid = ev->match_bits;
339 req->rq_reqbuf = ev->md_start + ev->offset;
340 if (ev->type == LNET_EVENT_PUT && ev->status == 0)
341 req->rq_reqdata_len = ev->mlength;
342 ktime_get_real_ts64(&req->rq_arrival_time);
343 /* Multi-Rail: keep track of both initiator and source NID. */
344 req->rq_peer = ev->initiator;
345 req->rq_source = ev->source;
346 req->rq_self = ev->target.nid;
348 req->rq_phase = RQ_PHASE_NEW;
349 if (ev->type == LNET_EVENT_PUT)
350 CDEBUG(D_INFO, "incoming req@%p x%llu msgsize %u\n",
351 req, req->rq_xid, ev->mlength);
353 CDEBUG(D_RPCTRACE, "peer: %s (source: %s)\n",
354 libcfs_id2str(req->rq_peer), libcfs_id2str(req->rq_source));
356 spin_lock(&svcpt->scp_lock);
358 ptlrpc_req_add_history(svcpt, req);
361 svcpt->scp_nrqbds_posted--;
362 CDEBUG(D_INFO, "Buffer complete: %d buffers still posted\n",
363 svcpt->scp_nrqbds_posted);
365 /* Normally, don't complain about 0 buffers posted; LNET won't
366 * drop incoming reqs since we set the portal lazy */
367 if (test_req_buffer_pressure &&
368 ev->type != LNET_EVENT_UNLINK &&
369 svcpt->scp_nrqbds_posted == 0)
370 CWARN("All %s request buffers busy\n",
373 /* req takes over the network's ref on rqbd */
375 /* req takes a ref on rqbd */
376 rqbd->rqbd_refcount++;
379 list_add_tail(&req->rq_list, &svcpt->scp_req_incoming);
380 svcpt->scp_nreqs_incoming++;
382 /* NB everything can disappear under us once the request
383 * has been queued and we unlock, so do the wake now... */
384 wake_up(&svcpt->scp_waitq);
386 spin_unlock(&svcpt->scp_lock);
391 * Server's outgoing reply callback
393 void reply_out_callback(struct lnet_event *ev)
395 struct ptlrpc_cb_id *cbid = ev->md_user_ptr;
396 struct ptlrpc_reply_state *rs = cbid->cbid_arg;
397 struct ptlrpc_service_part *svcpt = rs->rs_svcpt;
400 LASSERT (ev->type == LNET_EVENT_SEND ||
401 ev->type == LNET_EVENT_ACK ||
402 ev->type == LNET_EVENT_UNLINK);
404 if (!rs->rs_difficult) {
405 /* 'Easy' replies have no further processing so I drop the
406 * net's ref on 'rs' */
407 LASSERT (ev->unlinked);
408 ptlrpc_rs_decref(rs);
413 LASSERT (rs->rs_on_net);
416 /* Last network callback. The net's ref on 'rs' stays put
417 * until ptlrpc_handle_rs() is done with it */
418 spin_lock(&svcpt->scp_rep_lock);
419 spin_lock(&rs->rs_lock);
422 if (!rs->rs_no_ack ||
424 rs->rs_export->exp_obd->obd_last_committed ||
425 list_empty(&rs->rs_obd_list))
426 ptlrpc_schedule_difficult_reply(rs);
428 spin_unlock(&rs->rs_lock);
429 spin_unlock(&svcpt->scp_rep_lock);
434 #ifdef HAVE_SERVER_SUPPORT
436 * Server's bulk completion callback
438 void server_bulk_callback(struct lnet_event *ev)
440 struct ptlrpc_cb_id *cbid = ev->md_user_ptr;
441 struct ptlrpc_bulk_desc *desc = cbid->cbid_arg;
444 LASSERT(ev->type == LNET_EVENT_SEND ||
445 ev->type == LNET_EVENT_UNLINK ||
446 (ptlrpc_is_bulk_put_source(desc->bd_type) &&
447 ev->type == LNET_EVENT_ACK) ||
448 (ptlrpc_is_bulk_get_sink(desc->bd_type) &&
449 ev->type == LNET_EVENT_REPLY));
451 CDEBUG((ev->status == 0) ? D_NET : D_ERROR,
452 "event type %d, status %d, desc %p\n",
453 ev->type, ev->status, desc);
455 spin_lock(&desc->bd_lock);
457 LASSERT(desc->bd_refs > 0);
459 if ((ev->type == LNET_EVENT_ACK ||
460 ev->type == LNET_EVENT_REPLY) &&
462 /* We heard back from the peer, so even if we get this
463 * before the SENT event (oh yes we can), we know we
464 * read/wrote the peer buffer and how much... */
465 desc->bd_nob_transferred += ev->mlength;
466 desc->bd_sender = ev->sender;
470 desc->bd_failure = 1;
474 /* This is the last callback no matter what... */
475 if (desc->bd_refs == 0)
476 wake_up(&desc->bd_waitq);
479 spin_unlock(&desc->bd_lock);
484 static void ptlrpc_master_callback(struct lnet_event *ev)
486 struct ptlrpc_cb_id *cbid = ev->md_user_ptr;
487 void (*callback)(struct lnet_event *ev) = cbid->cbid_fn;
489 /* Honestly, it's best to find out early. */
490 LASSERT(cbid->cbid_arg != LP_POISON);
491 LASSERT(callback == request_out_callback ||
492 callback == reply_in_callback ||
493 callback == client_bulk_callback ||
494 callback == request_in_callback ||
495 callback == reply_out_callback
496 #ifdef HAVE_SERVER_SUPPORT
497 || callback == server_bulk_callback
503 percpu_ref_put(&ptlrpc_pending);
506 int ptlrpc_uuid_to_peer(struct obd_uuid *uuid,
507 struct lnet_process_id *peer, lnet_nid_t *self)
510 __u32 best_order = 0;
518 peer->pid = LNET_PID_LUSTRE;
520 /* Choose the matching UUID that's closest */
521 while (lustre_uuid_to_peer(uuid->uuid, &dst_nid, count++) == 0) {
522 if (peer->nid != LNET_NID_ANY && LNET_NIDADDR(peer->nid) == 0 &&
523 LNET_NIDNET(dst_nid) != LNET_NIDNET(peer->nid))
526 dist = LNetDist(dst_nid, &src_nid, &order);
530 if (dist == 0) { /* local! use loopback LND */
531 peer->nid = *self = LNET_NID_LO_0;
538 (dist == best_dist && order < best_order)) {
548 CDEBUG(D_NET, "%s->%s\n", uuid->uuid, libcfs_id2str(*peer));
552 static struct completion ptlrpc_done;
554 static void ptlrpc_release(struct percpu_ref *ref)
556 complete(&ptlrpc_done);
559 static void ptlrpc_ni_fini(void)
561 /* Wait for the event queue to become idle since there may still be
562 * messages in flight with pending events (i.e. the fire-and-forget
563 * messages == client requests and "non-difficult" server
566 init_completion(&ptlrpc_done);
567 percpu_ref_kill(&ptlrpc_pending);
568 wait_for_completion(&ptlrpc_done);
570 lnet_assert_handler_unused(ptlrpc_handler);
574 lnet_pid_t ptl_get_pid(void)
576 return LNET_PID_LUSTRE;
579 int ptlrpc_ni_init(void)
585 CDEBUG(D_NET, "My pid is: %x\n", pid);
587 /* We're not passing any limits yet... */
588 rc = LNetNIInit(pid);
590 CDEBUG(D_NET, "ptlrpc: Can't init network interface: rc = %d\n",
595 rc = percpu_ref_init(&ptlrpc_pending, ptlrpc_release, 0, GFP_KERNEL);
597 CERROR("ptlrpc: Can't init percpu refcount: rc = %d\n", rc);
600 /* CAVEAT EMPTOR: how we process portals events is _radically_
601 * different depending on...
603 /* kernel LNet calls our master callback when there are new event,
604 * because we are guaranteed to get every event via callback,
605 * so we just set EQ size to 0 to avoid overhread of serializing
606 * enqueue/dequeue operations in LNet. */
607 ptlrpc_handler = ptlrpc_master_callback;
611 int ptlrpc_init_portals(void)
613 int rc = ptlrpc_ni_init();
616 CERROR("network initialisation failed\n");
619 rc = ptlrpcd_addref();
623 CERROR("rpcd initialisation failed\n");
628 void ptlrpc_exit_portals(void)