lustre/ptlrpc/ptlrpcd.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   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.
   9  *
  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).
  15  *
  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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2014, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  *
  36  * lustre/ptlrpc/ptlrpcd.c
  37  */
  38
  39 /** \defgroup ptlrpcd PortalRPC daemon
  40  *
  41  * ptlrpcd is a special thread with its own set where other user might add
  42  * requests when they don't want to wait for their completion.
  43  * PtlRPCD will take care of sending such requests and then processing their
  44  * replies and calling completion callbacks as necessary.
  45  * The callbacks are called directly from ptlrpcd context.
  46  * It is important to never significantly block (esp. on RPCs!) within such
  47  * completion handler or a deadlock might occur where ptlrpcd enters some
  48  * callback that attempts to send another RPC and wait for it to return,
  49  * during which time ptlrpcd is completely blocked, so e.g. if import
  50  * fails, recovery cannot progress because connection requests are also
  51  * sent by ptlrpcd.
  52  *
  53  * @{
  54  */
  55
  56 #define DEBUG_SUBSYSTEM S_RPC
  57
  58 #include <linux/kthread.h>
  59 #include <libcfs/libcfs.h>
  60 #include <lustre_net.h>
  61 #include <lustre_lib.h>
  62 #include <lustre_ha.h>
  63 #include <obd_class.h>   /* for obd_zombie */
  64 #include <obd_support.h> /* for OBD_FAIL_CHECK */
  65 #include <cl_object.h> /* cl_env_{get,put}() */
  66 #include <lprocfs_status.h>
  67
  68 #include "ptlrpc_internal.h"
  69
  70 /* One of these per CPT. */
  71 struct ptlrpcd {
  72         int                     pd_size;
  73         int                     pd_index;
  74         int                     pd_cpt;
  75         int                     pd_cursor;
  76         int                     pd_nthreads;
  77         int                     pd_groupsize;
  78         struct ptlrpcd_ctl      pd_threads[0];
  79 };
  80
  81 /*
  82  * max_ptlrpcds is obsolete, but retained to ensure that the kernel
  83  * module will load on a system where it has been tuned.
  84  * A value other than 0 implies it was tuned, in which case the value
  85  * is used to derive a setting for ptlrpcd_per_cpt_max.
  86  */
  87 static int max_ptlrpcds;
  88 CFS_MODULE_PARM(max_ptlrpcds, "i", int, 0644,
  89                 "Max ptlrpcd thread count to be started.");
  90
  91 /*
  92  * ptlrpcd_bind_policy is obsolete, but retained to ensure that
  93  * the kernel module will load on a system where it has been tuned.
  94  * A value other than 0 implies it was tuned, in which case the value
  95  * is used to derive a setting for ptlrpcd_partner_group_size.
  96  */
  97 static int ptlrpcd_bind_policy;
  98 CFS_MODULE_PARM(ptlrpcd_bind_policy, "i", int, 0644,
  99                 "Ptlrpcd threads binding mode (obsolete).");
 100
 101 /*
 102  * ptlrpcd_per_cpt_max: The maximum number of ptlrpcd threads to run
 103  * in a CPT.
 104  */
 105 static int ptlrpcd_per_cpt_max;
 106 CFS_MODULE_PARM(ptlrpcd_per_cpt_max, "i", int, 0644,
 107                 "Max ptlrpcd thread count to be started per cpt.");
 108
 109 /*
 110  * ptlrpcd_partner_group_size: The desired number of threads in each
 111  * ptlrpcd partner thread group. Default is 2, corresponding to the
 112  * old PDB_POLICY_PAIR. A negative value makes all ptlrpcd threads in
 113  * a CPT partners of each other.
 114  */
 115 static int ptlrpcd_partner_group_size;
 116 CFS_MODULE_PARM(ptlrpcd_partner_group_size, "i", int, 0644,
 117                 "Number of ptlrpcd threads in a partner group.");
 118
 119 /*
 120  * ptlrpcd_cpts: A CPT string describing the CPU partitions that
 121  * ptlrpcd threads should run on. Used to make ptlrpcd threads run on
 122  * a subset of all CPTs.
 123  *
 124  * ptlrpcd_cpts=2
 125  * ptlrpcd_cpts=[2]
 126  *   run ptlrpcd threads only on CPT 2.
 127  *
 128  * ptlrpcd_cpts=0-3
 129  * ptlrpcd_cpts=[0-3]
 130  *   run ptlrpcd threads on CPTs 0, 1, 2, and 3.
 131  *
 132  * ptlrpcd_cpts=[0-3,5,7]
 133  *   run ptlrpcd threads on CPTS 0, 1, 2, 3, 5, and 7.
 134  */
 135 static char *ptlrpcd_cpts;
 136 CFS_MODULE_PARM(ptlrpcd_cpts, "s", charp, 0644,
 137                 "CPU partitions ptlrpcd threads should run in");
 138
 139 /* ptlrpcds_cpt_idx maps cpt numbers to an index in the ptlrpcds array. */
 140 static int              *ptlrpcds_cpt_idx;
 141
 142 /* ptlrpcds_num is the number of entries in the ptlrpcds array. */
 143 static int              ptlrpcds_num;
 144 static struct ptlrpcd   **ptlrpcds;
 145
 146 /*
 147  * In addition to the regular thread pool above, there is a single
 148  * global recovery thread. Recovery isn't critical for performance,
 149  * and doesn't block, but must always be able to proceed, and it is
 150  * possible that all normal ptlrpcd threads are blocked. Hence the
 151  * need for a dedicated thread.
 152  */
 153 static struct ptlrpcd_ctl ptlrpcd_rcv;
 154
 155 struct mutex ptlrpcd_mutex;
 156 static int ptlrpcd_users = 0;
 157
 158 void ptlrpcd_wake(struct ptlrpc_request *req)
 159 {
 160         struct ptlrpc_request_set *set = req->rq_set;
 161
 162         LASSERT(set != NULL);
 163         wake_up(&set->set_waitq);
 164 }
 165 EXPORT_SYMBOL(ptlrpcd_wake);
 166
 167 static struct ptlrpcd_ctl *
 168 ptlrpcd_select_pc(struct ptlrpc_request *req)
 169 {
 170         struct ptlrpcd  *pd;
 171         int             cpt;
 172         int             idx;
 173
 174         if (req != NULL && req->rq_send_state != LUSTRE_IMP_FULL)
 175                 return &ptlrpcd_rcv;
 176
 177         cpt = cfs_cpt_current(cfs_cpt_table, 1);
 178         if (ptlrpcds_cpt_idx == NULL)
 179                 idx = cpt;
 180         else
 181                 idx = ptlrpcds_cpt_idx[cpt];
 182         pd = ptlrpcds[idx];
 183
 184         /* We do not care whether it is strict load balance. */
 185         idx = pd->pd_cursor;
 186         if (++idx == pd->pd_nthreads)
 187                 idx = 0;
 188         pd->pd_cursor = idx;
 189
 190         return &pd->pd_threads[idx];
 191 }
 192
 193 /**
 194  * Move all request from an existing request set to the ptlrpcd queue.
 195  * All requests from the set must be in phase RQ_PHASE_NEW.
 196  */
 197 void ptlrpcd_add_rqset(struct ptlrpc_request_set *set)
 198 {
 199         struct list_head *tmp, *pos;
 200         struct ptlrpcd_ctl *pc;
 201         struct ptlrpc_request_set *new;
 202         int count, i;
 203
 204         pc = ptlrpcd_select_pc(NULL);
 205         new = pc->pc_set;
 206
 207         list_for_each_safe(pos, tmp, &set->set_requests) {
 208                 struct ptlrpc_request *req =
 209                         list_entry(pos, struct ptlrpc_request,
 210                                    rq_set_chain);
 211
 212                 LASSERT(req->rq_phase == RQ_PHASE_NEW);
 213                 req->rq_set = new;
 214                 req->rq_queued_time = cfs_time_current();
 215         }
 216
 217         spin_lock(&new->set_new_req_lock);
 218         list_splice_init(&set->set_requests, &new->set_new_requests);
 219         i = atomic_read(&set->set_remaining);
 220         count = atomic_add_return(i, &new->set_new_count);
 221         atomic_set(&set->set_remaining, 0);
 222         spin_unlock(&new->set_new_req_lock);
 223         if (count == i) {
 224                 wake_up(&new->set_waitq);
 225
 226                 /* XXX: It maybe unnecessary to wakeup all the partners. But to
 227                  *      guarantee the async RPC can be processed ASAP, we have
 228                  *      no other better choice. It maybe fixed in future. */
 229                 for (i = 0; i < pc->pc_npartners; i++)
 230                         wake_up(&pc->pc_partners[i]->pc_set->set_waitq);
 231         }
 232 }
 233
 234 /**
 235  * Return transferred RPCs count.
 236  */
 237 static int ptlrpcd_steal_rqset(struct ptlrpc_request_set *des,
 238                                struct ptlrpc_request_set *src)
 239 {
 240         struct list_head *tmp, *pos;
 241         struct ptlrpc_request *req;
 242         int rc = 0;
 243
 244         spin_lock(&src->set_new_req_lock);
 245         if (likely(!list_empty(&src->set_new_requests))) {
 246                 list_for_each_safe(pos, tmp, &src->set_new_requests) {
 247                         req = list_entry(pos, struct ptlrpc_request,
 248                                          rq_set_chain);
 249                         req->rq_set = des;
 250                 }
 251                 list_splice_init(&src->set_new_requests,
 252                                  &des->set_requests);
 253                 rc = atomic_read(&src->set_new_count);
 254                 atomic_add(rc, &des->set_remaining);
 255                 atomic_set(&src->set_new_count, 0);
 256         }
 257         spin_unlock(&src->set_new_req_lock);
 258         return rc;
 259 }
 260
 261 /**
 262  * Requests that are added to the ptlrpcd queue are sent via
 263  * ptlrpcd_check->ptlrpc_check_set().
 264  */
 265 void ptlrpcd_add_req(struct ptlrpc_request *req)
 266 {
 267         struct ptlrpcd_ctl *pc;
 268
 269         if (req->rq_reqmsg)
 270                 lustre_msg_set_jobid(req->rq_reqmsg, NULL);
 271
 272         spin_lock(&req->rq_lock);
 273         if (req->rq_invalid_rqset) {
 274                 struct l_wait_info lwi = LWI_TIMEOUT(cfs_time_seconds(5),
 275                                                      back_to_sleep, NULL);
 276
 277                 req->rq_invalid_rqset = 0;
 278                 spin_unlock(&req->rq_lock);
 279                 l_wait_event(req->rq_set_waitq, (req->rq_set == NULL), &lwi);
 280         } else if (req->rq_set) {
 281                 /* If we have a vaid "rq_set", just reuse it to avoid double
 282                  * linked. */
 283                 LASSERT(req->rq_phase == RQ_PHASE_NEW);
 284                 LASSERT(req->rq_send_state == LUSTRE_IMP_REPLAY);
 285
 286                 /* ptlrpc_check_set will decrease the count */
 287                 atomic_inc(&req->rq_set->set_remaining);
 288                 spin_unlock(&req->rq_lock);
 289                 wake_up(&req->rq_set->set_waitq);
 290                 return;
 291         } else {
 292                 spin_unlock(&req->rq_lock);
 293         }
 294
 295         pc = ptlrpcd_select_pc(req);
 296
 297         DEBUG_REQ(D_INFO, req, "add req [%p] to pc [%s:%d]",
 298                   req, pc->pc_name, pc->pc_index);
 299
 300         ptlrpc_set_add_new_req(pc, req);
 301 }
 302 EXPORT_SYMBOL(ptlrpcd_add_req);
 303
 304 static inline void ptlrpc_reqset_get(struct ptlrpc_request_set *set)
 305 {
 306         atomic_inc(&set->set_refcount);
 307 }
 308
 309 /**
 310  * Check if there is more work to do on ptlrpcd set.
 311  * Returns 1 if yes.
 312  */
 313 static int ptlrpcd_check(struct lu_env *env, struct ptlrpcd_ctl *pc)
 314 {
 315         struct list_head *tmp, *pos;
 316         struct ptlrpc_request *req;
 317         struct ptlrpc_request_set *set = pc->pc_set;
 318         int rc = 0;
 319         int rc2;
 320         ENTRY;
 321
 322         if (atomic_read(&set->set_new_count)) {
 323                 spin_lock(&set->set_new_req_lock);
 324                 if (likely(!list_empty(&set->set_new_requests))) {
 325                         list_splice_init(&set->set_new_requests,
 326                                              &set->set_requests);
 327                         atomic_add(atomic_read(&set->set_new_count),
 328                                    &set->set_remaining);
 329                         atomic_set(&set->set_new_count, 0);
 330                         /*
 331                          * Need to calculate its timeout.
 332                          */
 333                         rc = 1;
 334                 }
 335                 spin_unlock(&set->set_new_req_lock);
 336         }
 337
 338         /* We should call lu_env_refill() before handling new requests to make
 339          * sure that env key the requests depending on really exists.
 340          */
 341         rc2 = lu_env_refill(env);
 342         if (rc2 != 0) {
 343                 /*
 344                  * XXX This is very awkward situation, because
 345                  * execution can neither continue (request
 346                  * interpreters assume that env is set up), nor repeat
 347                  * the loop (as this potentially results in a tight
 348                  * loop of -ENOMEM's).
 349                  *
 350                  * Fortunately, refill only ever does something when
 351                  * new modules are loaded, i.e., early during boot up.
 352                  */
 353                 CERROR("Failure to refill session: %d\n", rc2);
 354                 RETURN(rc);
 355         }
 356
 357         if (atomic_read(&set->set_remaining))
 358                 rc |= ptlrpc_check_set(env, set);
 359
 360         /* NB: ptlrpc_check_set has already moved complted request at the
 361          * head of seq::set_requests */
 362         list_for_each_safe(pos, tmp, &set->set_requests) {
 363                 req = list_entry(pos, struct ptlrpc_request, rq_set_chain);
 364                 if (req->rq_phase != RQ_PHASE_COMPLETE)
 365                         break;
 366
 367                 list_del_init(&req->rq_set_chain);
 368                 req->rq_set = NULL;
 369                 ptlrpc_req_finished(req);
 370         }
 371
 372         if (rc == 0) {
 373                 /*
 374                  * If new requests have been added, make sure to wake up.
 375                  */
 376                 rc = atomic_read(&set->set_new_count);
 377
 378                 /* If we have nothing to do, check whether we can take some
 379                  * work from our partner threads. */
 380                 if (rc == 0 && pc->pc_npartners > 0) {
 381                         struct ptlrpcd_ctl *partner;
 382                         struct ptlrpc_request_set *ps;
 383                         int first = pc->pc_cursor;
 384
 385                         do {
 386                                 partner = pc->pc_partners[pc->pc_cursor++];
 387                                 if (pc->pc_cursor >= pc->pc_npartners)
 388                                         pc->pc_cursor = 0;
 389                                 if (partner == NULL)
 390                                         continue;
 391
 392                                 spin_lock(&partner->pc_lock);
 393                                 ps = partner->pc_set;
 394                                 if (ps == NULL) {
 395                                         spin_unlock(&partner->pc_lock);
 396                                         continue;
 397                                 }
 398
 399                                 ptlrpc_reqset_get(ps);
 400                                 spin_unlock(&partner->pc_lock);
 401
 402                                 if (atomic_read(&ps->set_new_count)) {
 403                                         rc = ptlrpcd_steal_rqset(set, ps);
 404                                         if (rc > 0)
 405                                                 CDEBUG(D_RPCTRACE, "transfer %d"
 406                                                        " async RPCs [%d->%d]\n",
 407                                                        rc, partner->pc_index,
 408                                                        pc->pc_index);
 409                                 }
 410                                 ptlrpc_reqset_put(ps);
 411                         } while (rc == 0 && pc->pc_cursor != first);
 412                 }
 413         }
 414
 415         RETURN(rc);
 416 }
 417
 418 /**
 419  * Main ptlrpcd thread.
 420  * ptlrpc's code paths like to execute in process context, so we have this
 421  * thread which spins on a set which contains the rpcs and sends them.
 422  *
 423  */
 424 static int ptlrpcd(void *arg)
 425 {
 426         struct ptlrpcd_ctl              *pc = arg;
 427         struct ptlrpc_request_set       *set;
 428         struct lu_context               ses = { 0 };
 429         struct lu_env                   env = { .le_ses = &ses };
 430         int                             rc = 0;
 431         int                             exit = 0;
 432         ENTRY;
 433
 434         unshare_fs_struct();
 435
 436         if (cfs_cpt_bind(cfs_cpt_table, pc->pc_cpt) != 0)
 437                 CWARN("Failed to bind %s on CPT %d\n", pc->pc_name, pc->pc_cpt);
 438
 439         /*
 440          * Allocate the request set after the thread has been bound
 441          * above. This is safe because no requests will be queued
 442          * until all ptlrpcd threads have confirmed that they have
 443          * successfully started.
 444          */
 445         set = ptlrpc_prep_set();
 446         if (set == NULL)
 447                 GOTO(failed, rc = -ENOMEM);
 448         spin_lock(&pc->pc_lock);
 449         pc->pc_set = set;
 450         spin_unlock(&pc->pc_lock);
 451
 452         /* Both client and server (MDT/OST) may use the environment. */
 453         rc = lu_context_init(&env.le_ctx, LCT_MD_THREAD |
 454                                           LCT_DT_THREAD |
 455                                           LCT_CL_THREAD |
 456                                           LCT_REMEMBER  |
 457                                           LCT_NOREF);
 458         if (rc != 0)
 459                 GOTO(failed, rc);
 460         rc = lu_context_init(env.le_ses, LCT_SESSION  |
 461                                          LCT_REMEMBER |
 462                                          LCT_NOREF);
 463         if (rc != 0) {
 464                 lu_context_fini(&env.le_ctx);
 465                 GOTO(failed, rc);
 466         }
 467
 468         complete(&pc->pc_starting);
 469
 470         /*
 471          * This mainloop strongly resembles ptlrpc_set_wait() except that our
 472          * set never completes.  ptlrpcd_check() calls ptlrpc_check_set() when
 473          * there are requests in the set. New requests come in on the set's
 474          * new_req_list and ptlrpcd_check() moves them into the set.
 475          */
 476         do {
 477                 struct l_wait_info lwi;
 478                 int timeout;
 479
 480                 timeout = ptlrpc_set_next_timeout(set);
 481                 lwi = LWI_TIMEOUT(cfs_time_seconds(timeout ? timeout : 1),
 482                                   ptlrpc_expired_set, set);
 483
 484                 lu_context_enter(&env.le_ctx);
 485                 lu_context_enter(env.le_ses);
 486                 l_wait_event(set->set_waitq, ptlrpcd_check(&env, pc), &lwi);
 487                 lu_context_exit(&env.le_ctx);
 488                 lu_context_exit(env.le_ses);
 489
 490                 /*
 491                  * Abort inflight rpcs for forced stop case.
 492                  */
 493                 if (test_bit(LIOD_STOP, &pc->pc_flags)) {
 494                         if (test_bit(LIOD_FORCE, &pc->pc_flags))
 495                                 ptlrpc_abort_set(set);
 496                         exit++;
 497                 }
 498
 499                 /*
 500                  * Let's make one more loop to make sure that ptlrpcd_check()
 501                  * copied all raced new rpcs into the set so we can kill them.
 502                  */
 503         } while (exit < 2);
 504
 505         /*
 506          * Wait for inflight requests to drain.
 507          */
 508         if (!list_empty(&set->set_requests))
 509                 ptlrpc_set_wait(set);
 510         lu_context_fini(&env.le_ctx);
 511         lu_context_fini(env.le_ses);
 512
 513         complete(&pc->pc_finishing);
 514
 515         return 0;
 516
 517 failed:
 518         pc->pc_error = rc;
 519         complete(&pc->pc_starting);
 520         RETURN(rc);
 521 }
 522
 523 static void ptlrpcd_ctl_init(struct ptlrpcd_ctl *pc, int index, int cpt)
 524 {
 525         ENTRY;
 526
 527         pc->pc_index = index;
 528         pc->pc_cpt = cpt;
 529         init_completion(&pc->pc_starting);
 530         init_completion(&pc->pc_finishing);
 531         spin_lock_init(&pc->pc_lock);
 532
 533         if (index < 0) {
 534                 /* Recovery thread. */
 535                 snprintf(pc->pc_name, sizeof(pc->pc_name), "ptlrpcd_rcv");
 536         } else {
 537                 /* Regular thread. */
 538                 snprintf(pc->pc_name, sizeof(pc->pc_name),
 539                          "ptlrpcd_%02d_%02d", cpt, index);
 540         }
 541
 542         EXIT;
 543 }
 544
 545 /* XXX: We want multiple CPU cores to share the async RPC load. So we
 546  *      start many ptlrpcd threads. We also want to reduce the ptlrpcd
 547  *      overhead caused by data transfer cross-CPU cores. So we bind
 548  *      all ptlrpcd threads to a CPT, in the expectation that CPTs
 549  *      will be defined in a way that matches these boundaries. Within
 550  *      a CPT a ptlrpcd thread can be scheduled on any available core.
 551  *
 552  *      Each ptlrpcd thread has its own request queue. This can cause
 553  *      response delay if the thread is already busy. To help with
 554  *      this we define partner threads: these are other threads bound
 555  *      to the same CPT which will check for work in each other's
 556  *      request queues if they have no work to do.
 557  *
 558  *      The desired number of partner threads can be tuned by setting
 559  *      ptlrpcd_partner_group_size. The default is to create pairs of
 560  *      partner threads.
 561  */
 562 static int ptlrpcd_partners(struct ptlrpcd *pd, int index)
 563 {
 564         struct ptlrpcd_ctl      *pc;
 565         struct ptlrpcd_ctl      **ppc;
 566         int                     first;
 567         int                     i;
 568         int                     rc = 0;
 569         ENTRY;
 570
 571         LASSERT(index >= 0 && index < pd->pd_nthreads);
 572         pc = &pd->pd_threads[index];
 573         pc->pc_npartners = pd->pd_groupsize - 1;
 574
 575         if (pc->pc_npartners <= 0)
 576                 GOTO(out, rc);
 577
 578         OBD_CPT_ALLOC(pc->pc_partners, cfs_cpt_table, pc->pc_cpt,
 579                       sizeof(struct ptlrpcd_ctl *) * pc->pc_npartners);
 580         if (pc->pc_partners == NULL) {
 581                 pc->pc_npartners = 0;
 582                 GOTO(out, rc = -ENOMEM);
 583         }
 584
 585         first = index - index % pd->pd_groupsize;
 586         ppc = pc->pc_partners;
 587         for (i = first; i < first + pd->pd_groupsize; i++) {
 588                 if (i != index)
 589                         *ppc++ = &pd->pd_threads[i];
 590         }
 591 out:
 592         RETURN(rc);
 593 }
 594
 595 int ptlrpcd_start(struct ptlrpcd_ctl *pc)
 596 {
 597         struct task_struct      *task;
 598         int                     rc = 0;
 599         ENTRY;
 600
 601         /*
 602          * Do not allow starting a second thread for one pc.
 603          */
 604         if (test_and_set_bit(LIOD_START, &pc->pc_flags)) {
 605                 CWARN("Starting second thread (%s) for same pc %p\n",
 606                       pc->pc_name, pc);
 607                 RETURN(0);
 608         }
 609
 610         /*
 611          * So far only "client" ptlrpcd uses an environment. In the future,
 612          * ptlrpcd thread (or a thread-set) has to be given an argument,
 613          * describing its "scope".
 614          */
 615         rc = lu_context_init(&pc->pc_env.le_ctx, LCT_CL_THREAD|LCT_REMEMBER);
 616         if (rc != 0)
 617                 GOTO(out, rc);
 618
 619         task = kthread_run(ptlrpcd, pc, pc->pc_name);
 620         if (IS_ERR(task))
 621                 GOTO(out_set, rc = PTR_ERR(task));
 622
 623         wait_for_completion(&pc->pc_starting);
 624         rc = pc->pc_error;
 625         if (rc != 0)
 626                 GOTO(out_set, rc);
 627
 628         RETURN(0);
 629
 630 out_set:
 631         if (pc->pc_set != NULL) {
 632                 struct ptlrpc_request_set *set = pc->pc_set;
 633
 634                 spin_lock(&pc->pc_lock);
 635                 pc->pc_set = NULL;
 636                 spin_unlock(&pc->pc_lock);
 637                 ptlrpc_set_destroy(set);
 638         }
 639         lu_context_fini(&pc->pc_env.le_ctx);
 640 out:
 641         clear_bit(LIOD_START, &pc->pc_flags);
 642         RETURN(rc);
 643 }
 644
 645 void ptlrpcd_stop(struct ptlrpcd_ctl *pc, int force)
 646 {
 647         ENTRY;
 648
 649         if (!test_bit(LIOD_START, &pc->pc_flags)) {
 650                 CWARN("Thread for pc %p was not started\n", pc);
 651                 goto out;
 652         }
 653
 654         set_bit(LIOD_STOP, &pc->pc_flags);
 655         if (force)
 656                 set_bit(LIOD_FORCE, &pc->pc_flags);
 657         wake_up(&pc->pc_set->set_waitq);
 658
 659 out:
 660         EXIT;
 661 }
 662
 663 void ptlrpcd_free(struct ptlrpcd_ctl *pc)
 664 {
 665         struct ptlrpc_request_set *set = pc->pc_set;
 666         ENTRY;
 667
 668         if (!test_bit(LIOD_START, &pc->pc_flags)) {
 669                 CWARN("Thread for pc %p was not started\n", pc);
 670                 goto out;
 671         }
 672
 673         wait_for_completion(&pc->pc_finishing);
 674         lu_context_fini(&pc->pc_env.le_ctx);
 675
 676         spin_lock(&pc->pc_lock);
 677         pc->pc_set = NULL;
 678         spin_unlock(&pc->pc_lock);
 679         ptlrpc_set_destroy(set);
 680
 681         clear_bit(LIOD_START, &pc->pc_flags);
 682         clear_bit(LIOD_STOP, &pc->pc_flags);
 683         clear_bit(LIOD_FORCE, &pc->pc_flags);
 684
 685 out:
 686         if (pc->pc_npartners > 0) {
 687                 LASSERT(pc->pc_partners != NULL);
 688
 689                 OBD_FREE(pc->pc_partners,
 690                          sizeof(struct ptlrpcd_ctl *) * pc->pc_npartners);
 691                 pc->pc_partners = NULL;
 692         }
 693         pc->pc_npartners = 0;
 694         pc->pc_error = 0;
 695         EXIT;
 696 }
 697
 698 static void ptlrpcd_fini(void)
 699 {
 700         int     i;
 701         int     j;
 702         int     ncpts;
 703         ENTRY;
 704
 705         if (ptlrpcds != NULL) {
 706                 for (i = 0; i < ptlrpcds_num; i++) {
 707                         if (ptlrpcds[i] == NULL)
 708                                 break;
 709                         for (j = 0; j < ptlrpcds[i]->pd_nthreads; j++)
 710                                 ptlrpcd_stop(&ptlrpcds[i]->pd_threads[j], 0);
 711                         for (j = 0; j < ptlrpcds[i]->pd_nthreads; j++)
 712                                 ptlrpcd_free(&ptlrpcds[i]->pd_threads[j]);
 713                         OBD_FREE(ptlrpcds[i], ptlrpcds[i]->pd_size);
 714                         ptlrpcds[i] = NULL;
 715                 }
 716                 OBD_FREE(ptlrpcds, sizeof(ptlrpcds[0]) * ptlrpcds_num);
 717         }
 718         ptlrpcds_num = 0;
 719
 720         ptlrpcd_stop(&ptlrpcd_rcv, 0);
 721         ptlrpcd_free(&ptlrpcd_rcv);
 722
 723         if (ptlrpcds_cpt_idx != NULL) {
 724                 ncpts = cfs_cpt_number(cfs_cpt_table);
 725                 OBD_FREE(ptlrpcds_cpt_idx, ncpts * sizeof(ptlrpcds_cpt_idx[0]));
 726                 ptlrpcds_cpt_idx = NULL;
 727         }
 728
 729         EXIT;
 730 }
 731
 732 static int ptlrpcd_init(void)
 733 {
 734         int                     nthreads;
 735         int                     groupsize;
 736         int                     size;
 737         int                     i;
 738         int                     j;
 739         int                     rc = 0;
 740         struct cfs_cpt_table    *cptable;
 741         __u32                   *cpts = NULL;
 742         int                     ncpts;
 743         int                     cpt;
 744         struct ptlrpcd          *pd;
 745         ENTRY;
 746
 747         /*
 748          * Determine the CPTs that ptlrpcd threads will run on.
 749          */
 750         cptable = cfs_cpt_table;
 751         ncpts = cfs_cpt_number(cptable);
 752         if (ptlrpcd_cpts != NULL) {
 753                 struct cfs_expr_list    *el;
 754
 755                 size = ncpts * sizeof(ptlrpcds_cpt_idx[0]);
 756                 OBD_ALLOC(ptlrpcds_cpt_idx, size);
 757                 if (ptlrpcds_cpt_idx == NULL)
 758                         GOTO(out, rc = -ENOMEM);
 759
 760                 rc = cfs_expr_list_parse(ptlrpcd_cpts,
 761                                          strlen(ptlrpcd_cpts),
 762                                          0, ncpts - 1, &el);
 763                 if (rc != 0) {
 764                         CERROR("%s: invalid CPT pattern string: %s",
 765                                "ptlrpcd_cpts", ptlrpcd_cpts);
 766                         GOTO(out, rc = -EINVAL);
 767                 }
 768
 769                 rc = cfs_expr_list_values(el, ncpts, &cpts);
 770                 cfs_expr_list_free(el);
 771                 if (rc <= 0) {
 772                         CERROR("%s: failed to parse CPT array %s: %d\n",
 773                                "ptlrpcd_cpts", ptlrpcd_cpts, rc);
 774                         if (rc == 0)
 775                                 rc = -EINVAL;
 776                         GOTO(out, rc);
 777                 }
 778
 779                 /*
 780                  * Create the cpt-to-index map. When there is no match
 781                  * in the cpt table, pick a cpt at random. This could
 782                  * be changed to take the topology of the system into
 783                  * account.
 784                  */
 785                 for (cpt = 0; cpt < ncpts; cpt++) {
 786                         for (i = 0; i < rc; i++)
 787                                 if (cpts[i] == cpt)
 788                                         break;
 789                         if (i >= rc)
 790                                 i = cpt % rc;
 791                         ptlrpcds_cpt_idx[cpt] = i;
 792                 }
 793
 794                 cfs_expr_list_values_free(cpts, rc);
 795                 ncpts = rc;
 796         }
 797         ptlrpcds_num = ncpts;
 798
 799         size = ncpts * sizeof(ptlrpcds[0]);
 800         OBD_ALLOC(ptlrpcds, size);
 801         if (ptlrpcds == NULL)
 802                 GOTO(out, rc = -ENOMEM);
 803
 804         /*
 805          * The max_ptlrpcds parameter is obsolete, but do something
 806          * sane if it has been tuned, and complain if
 807          * ptlrpcd_per_cpt_max has also been tuned.
 808          */
 809         if (max_ptlrpcds != 0) {
 810                 CWARN("max_ptlrpcds is obsolete.\n");
 811                 if (ptlrpcd_per_cpt_max == 0) {
 812                         ptlrpcd_per_cpt_max = max_ptlrpcds / ncpts;
 813                         /* Round up if there is a remainder. */
 814                         if (max_ptlrpcds % ncpts != 0)
 815                                 ptlrpcd_per_cpt_max++;
 816                         CWARN("Setting ptlrpcd_per_cpt_max = %d\n",
 817                               ptlrpcd_per_cpt_max);
 818                 } else {
 819                         CWARN("ptlrpd_per_cpt_max is also set!\n");
 820                 }
 821         }
 822
 823         /*
 824          * The ptlrpcd_bind_policy parameter is obsolete, but do
 825          * something sane if it has been tuned, and complain if
 826          * ptlrpcd_partner_group_size is also tuned.
 827          */
 828         if (ptlrpcd_bind_policy != 0) {
 829                 CWARN("ptlrpcd_bind_policy is obsolete.\n");
 830                 if (ptlrpcd_partner_group_size == 0) {
 831                         switch (ptlrpcd_bind_policy) {
 832                         case 1: /* PDB_POLICY_NONE */
 833                         case 2: /* PDB_POLICY_FULL */
 834                                 ptlrpcd_partner_group_size = 1;
 835                                 break;
 836                         case 3: /* PDB_POLICY_PAIR */
 837                                 ptlrpcd_partner_group_size = 2;
 838                                 break;
 839                         case 4: /* PDB_POLICY_NEIGHBOR */
 840 #ifdef CONFIG_NUMA
 841                                 ptlrpcd_partner_group_size = -1; /* CPT */
 842 #else
 843                                 ptlrpcd_partner_group_size = 3; /* Triplets */
 844 #endif
 845                                 break;
 846                         default: /* Illegal value, use the default. */
 847                                 ptlrpcd_partner_group_size = 2;
 848                                 break;
 849                         }
 850                         CWARN("Setting ptlrpcd_partner_group_size = %d\n",
 851                               ptlrpcd_partner_group_size);
 852                 } else {
 853                         CWARN("ptlrpcd_partner_group_size is also set!\n");
 854                 }
 855         }
 856
 857         if (ptlrpcd_partner_group_size == 0)
 858                 ptlrpcd_partner_group_size = 2;
 859         else if (ptlrpcd_partner_group_size < 0)
 860                 ptlrpcd_partner_group_size = -1;
 861         else if (ptlrpcd_per_cpt_max > 0 &&
 862                  ptlrpcd_partner_group_size > ptlrpcd_per_cpt_max)
 863                 ptlrpcd_partner_group_size = ptlrpcd_per_cpt_max;
 864
 865         /*
 866          * Start the recovery thread first.
 867          */
 868         set_bit(LIOD_RECOVERY, &ptlrpcd_rcv.pc_flags);
 869         ptlrpcd_ctl_init(&ptlrpcd_rcv, -1, CFS_CPT_ANY);
 870         rc = ptlrpcd_start(&ptlrpcd_rcv);
 871         if (rc < 0)
 872                 GOTO(out, rc);
 873
 874         for (i = 0; i < ncpts; i++) {
 875                 if (cpts == NULL)
 876                         cpt = i;
 877                 else
 878                         cpt = cpts[i];
 879
 880                 nthreads = cfs_cpt_weight(cptable, cpt);
 881                 if (ptlrpcd_per_cpt_max > 0 && ptlrpcd_per_cpt_max < nthreads)
 882                         nthreads = ptlrpcd_per_cpt_max;
 883                 if (nthreads < 2)
 884                         nthreads = 2;
 885
 886                 if (ptlrpcd_partner_group_size <= 0) {
 887                         groupsize = nthreads;
 888                 } else if (nthreads <= ptlrpcd_partner_group_size) {
 889                         groupsize = nthreads;
 890                 } else {
 891                         groupsize = ptlrpcd_partner_group_size;
 892                         if (nthreads % groupsize != 0)
 893                                 nthreads += groupsize - (nthreads % groupsize);
 894                 }
 895
 896                 size = offsetof(struct ptlrpcd, pd_threads[nthreads]);
 897                 OBD_CPT_ALLOC(pd, cptable, cpt, size);
 898                 if (!pd)
 899                         GOTO(out, rc = -ENOMEM);
 900                 pd->pd_size      = size;
 901                 pd->pd_index     = i;
 902                 pd->pd_cpt       = cpt;
 903                 pd->pd_cursor    = 0;
 904                 pd->pd_nthreads  = nthreads;
 905                 pd->pd_groupsize = groupsize;
 906                 ptlrpcds[i] = pd;
 907
 908                 /*
 909                  * The ptlrpcd threads in a partner group can access
 910                  * each other's struct ptlrpcd_ctl, so these must be
 911                  * initialized before any thead is started.
 912                  */
 913                 for (j = 0; j < nthreads; j++) {
 914                         ptlrpcd_ctl_init(&pd->pd_threads[j], j, cpt);
 915                         rc = ptlrpcd_partners(pd, j);
 916                         if (rc < 0)
 917                                 GOTO(out, rc);
 918                 }
 919
 920                 /* XXX: We start nthreads ptlrpc daemons on this cpt.
 921                  *      Each of them can process any non-recovery
 922                  *      async RPC to improve overall async RPC
 923                  *      efficiency.
 924                  *
 925                  *      But there are some issues with async I/O RPCs
 926                  *      and async non-I/O RPCs processed in the same
 927                  *      set under some cases. The ptlrpcd may be
 928                  *      blocked by some async I/O RPC(s), then will
 929                  *      cause other async non-I/O RPC(s) can not be
 930                  *      processed in time.
 931                  *
 932                  *      Maybe we should distinguish blocked async RPCs
 933                  *      from non-blocked async RPCs, and process them
 934                  *      in different ptlrpcd sets to avoid unnecessary
 935                  *      dependency. But how to distribute async RPCs
 936                  *      load among all the ptlrpc daemons becomes
 937                  *      another trouble.
 938                  */
 939                 for (j = 0; j < nthreads; j++) {
 940                         rc = ptlrpcd_start(&pd->pd_threads[j]);
 941                         if (rc < 0)
 942                                 GOTO(out, rc);
 943                 }
 944         }
 945 out:
 946         if (rc != 0)
 947                 ptlrpcd_fini();
 948
 949         RETURN(rc);
 950 }
 951
 952 int ptlrpcd_addref(void)
 953 {
 954         int rc = 0;
 955         ENTRY;
 956
 957         mutex_lock(&ptlrpcd_mutex);
 958         if (++ptlrpcd_users == 1) {
 959                 rc = ptlrpcd_init();
 960                 if (rc < 0)
 961                         ptlrpcd_users--;
 962         }
 963         mutex_unlock(&ptlrpcd_mutex);
 964         RETURN(rc);
 965 }
 966 EXPORT_SYMBOL(ptlrpcd_addref);
 967
 968 void ptlrpcd_decref(void)
 969 {
 970         mutex_lock(&ptlrpcd_mutex);
 971         if (--ptlrpcd_users == 0)
 972                 ptlrpcd_fini();
 973         mutex_unlock(&ptlrpcd_mutex);
 974 }
 975 EXPORT_SYMBOL(ptlrpcd_decref);
 976 /** @} ptlrpcd */