lustre/ptlrpc/nrs_crr.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,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License version 2 for more details.  A copy is
  14  * included in the COPYING file that accompanied this code.
  15
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2011 Intel Corporation
  24  *
  25  * Copyright 2012 Xyratex Technology Limited
  26  */
  27 /*
  28  * lustre/ptlrpc/nrs_crr.c
  29  *
  30  * Network Request Scheduler (NRS) CRR-N policy
  31  *
  32  * Request ordering in a batched Round-Robin manner over client NIDs
  33  *
  34  * Author: Liang Zhen <liang@whamcloud.com>
  35  * Author: Nikitas Angelinas <nikitas_angelinas@xyratex.com>
  36  */
  37 /**
  38  * \addtogoup nrs
  39  * @{
  40  */
  41 #ifdef HAVE_SERVER_SUPPORT
  42
  43 #define DEBUG_SUBSYSTEM S_RPC
  44 #ifndef __KERNEL__
  45 #include <liblustre.h>
  46 #endif
  47 #include <obd_support.h>
  48 #include <obd_class.h>
  49 #include <lustre_net.h>
  50 #include <lprocfs_status.h>
  51 #include "ptlrpc_internal.h"
  52
  53 /**
  54  * \name CRR-N policy
  55  *
  56  * Client Round-Robin scheduling over client NIDs
  57  *
  58  * @{
  59  *
  60  */
  61
  62 #define NRS_POL_NAME_CRRN       "crrn"
  63
  64 /**
  65  * Binary heap predicate.
  66  *
  67  * Uses ptlrpc_nrs_request::nr_u::crr::cr_round and
  68  * ptlrpc_nrs_request::nr_u::crr::cr_sequence to compare two binheap nodes and
  69  * produce a binary predicate that shows their relative priority, so that the
  70  * binary heap can perform the necessary sorting operations.
  71  *
  72  * \param[in] e1 the first binheap node to compare
  73  * \param[in] e2 the second binheap node to compare
  74  *
  75  * \retval 0 e1 > e2
  76  * \retval 1 e1 <= e2
  77  */
  78 static int crrn_req_compare(cfs_binheap_node_t *e1, cfs_binheap_node_t *e2)
  79 {
  80         struct ptlrpc_nrs_request *nrq1;
  81         struct ptlrpc_nrs_request *nrq2;
  82
  83         nrq1 = container_of(e1, struct ptlrpc_nrs_request, nr_node);
  84         nrq2 = container_of(e2, struct ptlrpc_nrs_request, nr_node);
  85
  86         if (nrq1->nr_u.crr.cr_round < nrq2->nr_u.crr.cr_round)
  87                 return 1;
  88         else if (nrq1->nr_u.crr.cr_round > nrq2->nr_u.crr.cr_round)
  89                 return 0;
  90
  91         return nrq1->nr_u.crr.cr_sequence < nrq2->nr_u.crr.cr_sequence;
  92 }
  93
  94 static cfs_binheap_ops_t nrs_crrn_heap_ops = {
  95         .hop_enter      = NULL,
  96         .hop_exit       = NULL,
  97         .hop_compare    = crrn_req_compare,
  98 };
  99
 100 /**
 101  * libcfs_hash operations for nrs_crrn_net::cn_cli_hash
 102  *
 103  * This uses ptlrpc_request::rq_peer.nid as its key, in order to hash
 104  * nrs_crrn_client objects.
 105  */
 106 #define NRS_NID_BKT_BITS        8
 107 #define NRS_NID_BITS            16
 108
 109 static unsigned nrs_crrn_hop_hash(cfs_hash_t *hs, const void *key,
 110                                   unsigned mask)
 111 {
 112         return cfs_hash_djb2_hash(key, sizeof(lnet_nid_t), mask);
 113 }
 114
 115 static int nrs_crrn_hop_keycmp(const void *key, cfs_hlist_node_t *hnode)
 116 {
 117         lnet_nid_t              *nid = (lnet_nid_t *)key;
 118         struct nrs_crrn_client  *cli = cfs_hlist_entry(hnode,
 119                                                        struct nrs_crrn_client,
 120                                                        cc_hnode);
 121         return *nid == cli->cc_nid;
 122 }
 123
 124 static void *nrs_crrn_hop_key(cfs_hlist_node_t *hnode)
 125 {
 126         struct nrs_crrn_client  *cli = cfs_hlist_entry(hnode,
 127                                                        struct nrs_crrn_client,
 128                                                        cc_hnode);
 129         return &cli->cc_nid;
 130 }
 131
 132 static void *nrs_crrn_hop_object(cfs_hlist_node_t *hnode)
 133 {
 134         return cfs_hlist_entry(hnode, struct nrs_crrn_client, cc_hnode);
 135 }
 136
 137 static void nrs_crrn_hop_get(cfs_hash_t *hs, cfs_hlist_node_t *hnode)
 138 {
 139         struct nrs_crrn_client *cli = cfs_hlist_entry(hnode,
 140                                                       struct nrs_crrn_client,
 141                                                       cc_hnode);
 142         atomic_inc(&cli->cc_ref);
 143 }
 144
 145 static void nrs_crrn_hop_put(cfs_hash_t *hs, cfs_hlist_node_t *hnode)
 146 {
 147         struct nrs_crrn_client  *cli = cfs_hlist_entry(hnode,
 148                                                        struct nrs_crrn_client,
 149                                                        cc_hnode);
 150         atomic_dec(&cli->cc_ref);
 151 }
 152
 153 static void nrs_crrn_hop_exit(cfs_hash_t *hs, cfs_hlist_node_t *hnode)
 154 {
 155         struct nrs_crrn_client  *cli = cfs_hlist_entry(hnode,
 156                                                        struct nrs_crrn_client,
 157                                                        cc_hnode);
 158         LASSERTF(atomic_read(&cli->cc_ref) == 0,
 159                  "Busy CRR-N object from client with NID %s, with %d refs\n",
 160                  libcfs_nid2str(cli->cc_nid), atomic_read(&cli->cc_ref));
 161
 162         OBD_FREE_PTR(cli);
 163 }
 164
 165 static cfs_hash_ops_t nrs_crrn_hash_ops = {
 166         .hs_hash        = nrs_crrn_hop_hash,
 167         .hs_keycmp      = nrs_crrn_hop_keycmp,
 168         .hs_key         = nrs_crrn_hop_key,
 169         .hs_object      = nrs_crrn_hop_object,
 170         .hs_get         = nrs_crrn_hop_get,
 171         .hs_put         = nrs_crrn_hop_put,
 172         .hs_put_locked  = nrs_crrn_hop_put,
 173         .hs_exit        = nrs_crrn_hop_exit,
 174 };
 175
 176 /**
 177  * Called when a CRR-N policy instance is started.
 178  *
 179  * \param[in] policy the policy
 180  *
 181  * \retval -ENOMEM OOM error
 182  * \retval 0       success
 183  */
 184 static int nrs_crrn_start(struct ptlrpc_nrs_policy *policy, char *arg)
 185 {
 186         struct nrs_crrn_net    *net;
 187         int                     rc = 0;
 188         ENTRY;
 189
 190         OBD_CPT_ALLOC_PTR(net, nrs_pol2cptab(policy), nrs_pol2cptid(policy));
 191         if (net == NULL)
 192                 RETURN(-ENOMEM);
 193
 194         net->cn_binheap = cfs_binheap_create(&nrs_crrn_heap_ops,
 195                                              CBH_FLAG_ATOMIC_GROW, 4096, NULL,
 196                                              nrs_pol2cptab(policy),
 197                                              nrs_pol2cptid(policy));
 198         if (net->cn_binheap == NULL)
 199                 GOTO(failed, rc = -ENOMEM);
 200
 201         net->cn_cli_hash = cfs_hash_create("nrs_crrn_nid_hash",
 202                                            NRS_NID_BITS, NRS_NID_BITS,
 203                                            NRS_NID_BKT_BITS, 0,
 204                                            CFS_HASH_MIN_THETA,
 205                                            CFS_HASH_MAX_THETA,
 206                                            &nrs_crrn_hash_ops,
 207                                            CFS_HASH_RW_BKTLOCK);
 208         if (net->cn_cli_hash == NULL)
 209                 GOTO(failed, rc = -ENOMEM);
 210
 211         /**
 212          * Set default quantum value to max_rpcs_in_flight for non-MDS OSCs;
 213          * there may be more RPCs pending from each struct nrs_crrn_client even
 214          * with the default max_rpcs_in_flight value, as we are scheduling over
 215          * NIDs, and there may be more than one mount point per client.
 216          */
 217         net->cn_quantum = OSC_MAX_RIF_DEFAULT;
 218         /**
 219          * Set to 1 so that the test inside nrs_crrn_req_add() can evaluate to
 220          * true.
 221          */
 222         net->cn_sequence = 1;
 223
 224         policy->pol_private = net;
 225
 226         RETURN(rc);
 227
 228 failed:
 229         if (net->cn_binheap != NULL)
 230                 cfs_binheap_destroy(net->cn_binheap);
 231
 232         OBD_FREE_PTR(net);
 233
 234         RETURN(rc);
 235 }
 236
 237 /**
 238  * Called when a CRR-N policy instance is stopped.
 239  *
 240  * Called when the policy has been instructed to transition to the
 241  * ptlrpc_nrs_pol_state::NRS_POL_STATE_STOPPED state and has no more pending
 242  * requests to serve.
 243  *
 244  * \param[in] policy the policy
 245  */
 246 static void nrs_crrn_stop(struct ptlrpc_nrs_policy *policy)
 247 {
 248         struct nrs_crrn_net     *net = policy->pol_private;
 249         ENTRY;
 250
 251         LASSERT(net != NULL);
 252         LASSERT(net->cn_binheap != NULL);
 253         LASSERT(net->cn_cli_hash != NULL);
 254         LASSERT(cfs_binheap_is_empty(net->cn_binheap));
 255
 256         cfs_binheap_destroy(net->cn_binheap);
 257         cfs_hash_putref(net->cn_cli_hash);
 258
 259         OBD_FREE_PTR(net);
 260 }
 261
 262 /**
 263  * Performs a policy-specific ctl function on CRR-N policy instances; similar
 264  * to ioctl.
 265  *
 266  * \param[in]     policy the policy instance
 267  * \param[in]     opc    the opcode
 268  * \param[in,out] arg    used for passing parameters and information
 269  *
 270  * \pre assert_spin_locked(&policy->pol_nrs->->nrs_lock)
 271  * \post assert_spin_locked(&policy->pol_nrs->->nrs_lock)
 272  *
 273  * \retval 0   operation carried out successfully
 274  * \retval -ve error
 275  */
 276 int nrs_crrn_ctl(struct ptlrpc_nrs_policy *policy, enum ptlrpc_nrs_ctl opc,
 277                  void *arg)
 278 {
 279         assert_spin_locked(&policy->pol_nrs->nrs_lock);
 280
 281         switch((enum nrs_ctl_crr)opc) {
 282         default:
 283                 RETURN(-EINVAL);
 284
 285         /**
 286          * Read Round Robin quantum size of a policy instance.
 287          */
 288         case NRS_CTL_CRRN_RD_QUANTUM: {
 289                 struct nrs_crrn_net     *net = policy->pol_private;
 290
 291                 *(__u16 *)arg = net->cn_quantum;
 292                 }
 293                 break;
 294
 295         /**
 296          * Write Round Robin quantum size of a policy instance.
 297          */
 298         case NRS_CTL_CRRN_WR_QUANTUM: {
 299                 struct nrs_crrn_net     *net = policy->pol_private;
 300
 301                 net->cn_quantum = *(__u16 *)arg;
 302                 LASSERT(net->cn_quantum != 0);
 303                 }
 304                 break;
 305         }
 306
 307         RETURN(0);
 308 }
 309
 310 /**
 311  * Obtains resources from CRR-N policy instances. The top-level resource lives
 312  * inside \e nrs_crrn_net and the second-level resource inside
 313  * \e nrs_crrn_client object instances.
 314  *
 315  * \param[in]  policy     the policy for which resources are being taken for
 316  *                        request \a nrq
 317  * \param[in]  nrq        the request for which resources are being taken
 318  * \param[in]  parent     parent resource, embedded in nrs_crrn_net for the
 319  *                        CRR-N policy
 320  * \param[out] resp       resources references are placed in this array
 321  * \param[in]  moving_req signifies limited caller context; used to perform
 322  *                        memory allocations in an atomic context in this
 323  *                        policy
 324  *
 325  * \retval 0   we are returning a top-level, parent resource, one that is
 326  *             embedded in an nrs_crrn_net object
 327  * \retval 1   we are returning a bottom-level resource, one that is embedded
 328  *             in an nrs_crrn_client object
 329  *
 330  * \see nrs_resource_get_safe()
 331  */
 332 int nrs_crrn_res_get(struct ptlrpc_nrs_policy *policy,
 333                      struct ptlrpc_nrs_request *nrq,
 334                      const struct ptlrpc_nrs_resource *parent,
 335                      struct ptlrpc_nrs_resource **resp, bool moving_req)
 336 {
 337         struct nrs_crrn_net     *net;
 338         struct nrs_crrn_client  *cli;
 339         struct nrs_crrn_client  *tmp;
 340         struct ptlrpc_request   *req;
 341
 342         if (parent == NULL) {
 343                 *resp = &((struct nrs_crrn_net *)policy->pol_private)->cn_res;
 344                 return 0;
 345         }
 346
 347         net = container_of(parent, struct nrs_crrn_net, cn_res);
 348         req = container_of(nrq, struct ptlrpc_request, rq_nrq);
 349
 350         cli = cfs_hash_lookup(net->cn_cli_hash, &req->rq_peer.nid);
 351         if (cli != NULL)
 352                 goto out;
 353
 354         OBD_CPT_ALLOC_GFP(cli, nrs_pol2cptab(policy), nrs_pol2cptid(policy),
 355                           sizeof(*cli), moving_req ? GFP_ATOMIC : GFP_NOFS);
 356         if (cli == NULL)
 357                 return -ENOMEM;
 358
 359         cli->cc_nid = req->rq_peer.nid;
 360
 361         atomic_set(&cli->cc_ref, 1);
 362         tmp = cfs_hash_findadd_unique(net->cn_cli_hash, &cli->cc_nid,
 363                                       &cli->cc_hnode);
 364         if (tmp != cli) {
 365                 OBD_FREE_PTR(cli);
 366                 cli = tmp;
 367         }
 368 out:
 369         *resp = &cli->cc_res;
 370
 371         return 1;
 372 }
 373
 374 /**
 375  * Called when releasing references to the resource hierachy obtained for a
 376  * request for scheduling using the CRR-N policy.
 377  *
 378  * \param[in] policy   the policy the resource belongs to
 379  * \param[in] res      the resource to be released
 380  */
 381 static void nrs_crrn_res_put(struct ptlrpc_nrs_policy *policy,
 382                              const struct ptlrpc_nrs_resource *res)
 383 {
 384         struct nrs_crrn_net     *net;
 385         struct nrs_crrn_client  *cli;
 386
 387         /**
 388          * Do nothing for freeing parent, nrs_crrn_net resources
 389          */
 390         if (res->res_parent == NULL)
 391                 return;
 392
 393         cli = container_of(res, struct nrs_crrn_client, cc_res);
 394         net = container_of(res->res_parent, struct nrs_crrn_net, cn_res);
 395
 396         cfs_hash_put(net->cn_cli_hash, &cli->cc_hnode);
 397 }
 398
 399 /**
 400  * Called when getting a request from the CRR-N policy for handlingso that it can be served
 401  *
 402  * \param[in] policy the policy being polled
 403  * \param[in] peek   when set, signifies that we just want to examine the
 404  *                   request, and not handle it, so the request is not removed
 405  *                   from the policy.
 406  * \param[in] force  force the policy to return a request; unused in this policy
 407  *
 408  * \retval the request to be handled
 409  * \retval NULL no request available
 410  *
 411  * \see ptlrpc_nrs_req_get_nolock()
 412  * \see nrs_request_get()
 413  */
 414 static
 415 struct ptlrpc_nrs_request *nrs_crrn_req_get(struct ptlrpc_nrs_policy *policy,
 416                                             bool peek, bool force)
 417 {
 418         struct nrs_crrn_net       *net = policy->pol_private;
 419         cfs_binheap_node_t        *node = cfs_binheap_root(net->cn_binheap);
 420         struct ptlrpc_nrs_request *nrq;
 421
 422         nrq = unlikely(node == NULL) ? NULL :
 423               container_of(node, struct ptlrpc_nrs_request, nr_node);
 424
 425         if (likely(!peek && nrq != NULL)) {
 426                 struct nrs_crrn_client *cli;
 427                 struct ptlrpc_request *req = container_of(nrq,
 428                                                           struct ptlrpc_request,
 429                                                           rq_nrq);
 430
 431                 cli = container_of(nrs_request_resource(nrq),
 432                                    struct nrs_crrn_client, cc_res);
 433
 434                 LASSERT(nrq->nr_u.crr.cr_round <= cli->cc_round);
 435
 436                 cfs_binheap_remove(net->cn_binheap, &nrq->nr_node);
 437                 cli->cc_active--;
 438
 439                 CDEBUG(D_RPCTRACE,
 440                        "NRS: starting to handle %s request from %s, with round "
 441                        LPU64"\n", NRS_POL_NAME_CRRN,
 442                        libcfs_id2str(req->rq_peer), nrq->nr_u.crr.cr_round);
 443
 444                 /** Peek at the next request to be served */
 445                 node = cfs_binheap_root(net->cn_binheap);
 446
 447                 /** No more requests */
 448                 if (unlikely(node == NULL)) {
 449                         net->cn_round++;
 450                 } else {
 451                         struct ptlrpc_nrs_request *next;
 452
 453                         next = container_of(node, struct ptlrpc_nrs_request,
 454                                             nr_node);
 455
 456                         if (net->cn_round < next->nr_u.crr.cr_round)
 457                                 net->cn_round = next->nr_u.crr.cr_round;
 458                 }
 459         }
 460
 461         return nrq;
 462 }
 463
 464 /**
 465  * Adds request \a nrq to a CRR-N \a policy instance's set of queued requests
 466  *
 467  * A scheduling round is a stream of requests that have been sorted in batches
 468  * according to the client that they originate from (as identified by its NID);
 469  * there can be only one batch for each client in each round. The batches are of
 470  * maximum size nrs_crrn_net:cn_quantum. When a new request arrives for
 471  * scheduling from a client that has exhausted its quantum in its current round,
 472  * it will start scheduling requests on the next scheduling round. Clients are
 473  * allowed to schedule requests against a round until all requests for the round
 474  * are serviced, so a client might miss a round if it is not generating requests
 475  * for a long enough period of time. Clients that miss a round will continue
 476  * with scheduling the next request that they generate, starting at the round
 477  * that requests are being dispatched for, at the time of arrival of this new
 478  * request.
 479  *
 480  * Requests are tagged with the round number and a sequence number; the sequence
 481  * number indicates the relative ordering amongst the batches of requests in a
 482  * round, and is identical for all requests in a batch, as is the round number.
 483  * The round and sequence numbers are used by crrn_req_compare() in order to
 484  * maintain an ordered set of rounds, with each round consisting of an ordered
 485  * set of batches of requests.
 486  *
 487  * \param[in] policy the policy
 488  * \param[in] nrq    the request to add
 489  *
 490  * \retval 0    request successfully added
 491  * \retval != 0 error
 492  */
 493 static int nrs_crrn_req_add(struct ptlrpc_nrs_policy *policy,
 494                             struct ptlrpc_nrs_request *nrq)
 495 {
 496         struct nrs_crrn_net     *net;
 497         struct nrs_crrn_client  *cli;
 498         int                      rc;
 499
 500         cli = container_of(nrs_request_resource(nrq),
 501                            struct nrs_crrn_client, cc_res);
 502         net = container_of(nrs_request_resource(nrq)->res_parent,
 503                            struct nrs_crrn_net, cn_res);
 504
 505         if (cli->cc_quantum == 0 || cli->cc_round < net->cn_round ||
 506             (cli->cc_active == 0 && cli->cc_quantum > 0)) {
 507
 508                 /**
 509                  * If the client has no pending requests, and still some of its
 510                  * quantum remaining unused, which implies it has not had a
 511                  * chance to schedule up to its maximum allowed batch size of
 512                  * requests in the previous round it participated, schedule this
 513                  * next request on a new round; this avoids fragmentation of
 514                  * request batches caused by client inactivity, at the expense
 515                  * of potentially slightly increased service time for the
 516                  * request batch this request will be a part of.
 517                  */
 518                 if (cli->cc_active == 0 && cli->cc_quantum > 0)
 519                         cli->cc_round++;
 520
 521                 /** A new scheduling round has commenced */
 522                 if (cli->cc_round < net->cn_round)
 523                         cli->cc_round = net->cn_round;
 524
 525                 /** I was not the last client through here */
 526                 if (cli->cc_sequence < net->cn_sequence)
 527                         cli->cc_sequence = ++net->cn_sequence;
 528                 /**
 529                  * Reset the quantum if we have reached the maximum quantum
 530                  * size for this batch, or even if we have not managed to
 531                  * complete a batch size up to its maximum allowed size.
 532                  * XXX: Accessed unlocked
 533                  */
 534                 cli->cc_quantum = net->cn_quantum;
 535         }
 536
 537         nrq->nr_u.crr.cr_round = cli->cc_round;
 538         nrq->nr_u.crr.cr_sequence = cli->cc_sequence;
 539
 540         rc = cfs_binheap_insert(net->cn_binheap, &nrq->nr_node);
 541         if (rc == 0) {
 542                 cli->cc_active++;
 543                 if (--cli->cc_quantum == 0)
 544                         cli->cc_round++;
 545         }
 546         return rc;
 547 }
 548
 549 /**
 550  * Removes request \a nrq from a CRR-N \a policy instance's set of queued
 551  * requests.
 552  *
 553  * \param[in] policy the policy
 554  * \param[in] nrq    the request to remove
 555  */
 556 static void nrs_crrn_req_del(struct ptlrpc_nrs_policy *policy,
 557                              struct ptlrpc_nrs_request *nrq)
 558 {
 559         struct nrs_crrn_net     *net;
 560         struct nrs_crrn_client  *cli;
 561         bool                     is_root;
 562
 563         cli = container_of(nrs_request_resource(nrq),
 564                            struct nrs_crrn_client, cc_res);
 565         net = container_of(nrs_request_resource(nrq)->res_parent,
 566                            struct nrs_crrn_net, cn_res);
 567
 568         LASSERT(nrq->nr_u.crr.cr_round <= cli->cc_round);
 569
 570         is_root = &nrq->nr_node == cfs_binheap_root(net->cn_binheap);
 571
 572         cfs_binheap_remove(net->cn_binheap, &nrq->nr_node);
 573         cli->cc_active--;
 574
 575         /**
 576          * If we just deleted the node at the root of the binheap, we may have
 577          * to adjust round numbers.
 578          */
 579         if (unlikely(is_root)) {
 580                 /** Peek at the next request to be served */
 581                 cfs_binheap_node_t *node = cfs_binheap_root(net->cn_binheap);
 582
 583                 /** No more requests */
 584                 if (unlikely(node == NULL)) {
 585                         net->cn_round++;
 586                 } else {
 587                         nrq = container_of(node, struct ptlrpc_nrs_request,
 588                                            nr_node);
 589
 590                         if (net->cn_round < nrq->nr_u.crr.cr_round)
 591                                 net->cn_round = nrq->nr_u.crr.cr_round;
 592                 }
 593         }
 594 }
 595
 596 /**
 597  * Called right after the request \a nrq finishes being handled by CRR-N policy
 598  * instance \a policy.
 599  *
 600  * \param[in] policy the policy that handled the request
 601  * \param[in] nrq    the request that was handled
 602  */
 603 static void nrs_crrn_req_stop(struct ptlrpc_nrs_policy *policy,
 604                               struct ptlrpc_nrs_request *nrq)
 605 {
 606         struct ptlrpc_request *req = container_of(nrq, struct ptlrpc_request,
 607                                                   rq_nrq);
 608
 609         CDEBUG(D_RPCTRACE,
 610                "NRS: finished handling %s request from %s, with round "LPU64
 611                "\n", NRS_POL_NAME_CRRN,
 612                libcfs_id2str(req->rq_peer), nrq->nr_u.crr.cr_round);
 613 }
 614
 615 #ifdef LPROCFS
 616
 617 /**
 618  * lprocfs interface
 619  */
 620
 621 /**
 622  * Retrieves the value of the Round Robin quantum (i.e. the maximum batch size)
 623  * for CRR-N policy instances on both the regular and high-priority NRS head
 624  * of a service, as long as a policy instance is not in the
 625  * ptlrpc_nrs_pol_state::NRS_POL_STATE_STOPPED state; policy instances in this
 626  * state are skipped later by nrs_crrn_ctl().
 627  *
 628  * Quantum values are in # of RPCs, and output is in YAML format.
 629  *
 630  * For example:
 631  *
 632  *      reg_quantum:8
 633  *      hp_quantum:4
 634  */
 635 static int
 636 ptlrpc_lprocfs_nrs_crrn_quantum_seq_show(struct seq_file *m, void *data)
 637 {
 638         struct ptlrpc_service   *svc = m->private;
 639         __u16                   quantum;
 640         int                     rc;
 641
 642         /**
 643          * Perform two separate calls to this as only one of the NRS heads'
 644          * policies may be in the ptlrpc_nrs_pol_state::NRS_POL_STATE_STARTED or
 645          * ptlrpc_nrs_pol_state::NRS_POL_STATE_STOPPING state.
 646          */
 647         rc = ptlrpc_nrs_policy_control(svc, PTLRPC_NRS_QUEUE_REG,
 648                                        NRS_POL_NAME_CRRN,
 649                                        NRS_CTL_CRRN_RD_QUANTUM,
 650                                        true, &quantum);
 651         if (rc == 0) {
 652                 seq_printf(m, NRS_LPROCFS_QUANTUM_NAME_REG
 653                            "%-5d\n", quantum);
 654                 /**
 655                  * Ignore -ENODEV as the regular NRS head's policy may be in the
 656                  * ptlrpc_nrs_pol_state::NRS_POL_STATE_STOPPED state.
 657                  */
 658         } else if (rc != -ENODEV) {
 659                 return rc;
 660         }
 661
 662         if (!nrs_svc_has_hp(svc))
 663                 goto no_hp;
 664
 665         rc = ptlrpc_nrs_policy_control(svc, PTLRPC_NRS_QUEUE_HP,
 666                                        NRS_POL_NAME_CRRN,
 667                                        NRS_CTL_CRRN_RD_QUANTUM,
 668                                        true, &quantum);
 669         if (rc == 0) {
 670                 seq_printf(m, NRS_LPROCFS_QUANTUM_NAME_HP"%-5d\n", quantum);
 671                 /**
 672                  * Ignore -ENODEV as the high priority NRS head's policy may be
 673                  * in the ptlrpc_nrs_pol_state::NRS_POL_STATE_STOPPED state.
 674                  */
 675         } else if (rc != -ENODEV) {
 676                 return rc;
 677         }
 678
 679 no_hp:
 680         return rc;
 681 }
 682
 683 /**
 684  * Sets the value of the Round Robin quantum (i.e. the maximum batch size)
 685  * for CRR-N policy instances of a service. The user can set the quantum size
 686  * for the regular or high priority NRS head individually by specifying each
 687  * value, or both together in a single invocation.
 688  *
 689  * For example:
 690  *
 691  * lctl set_param *.*.*.nrs_crrn_quantum=reg_quantum:32, to set the regular
 692  * request quantum size on all PTLRPC services to 32
 693  *
 694  * lctl set_param *.*.*.nrs_crrn_quantum=hp_quantum:16, to set the high
 695  * priority request quantum size on all PTLRPC services to 16, and
 696  *
 697  * lctl set_param *.*.ost_io.nrs_crrn_quantum=16, to set both the regular and
 698  * high priority request quantum sizes of the ost_io service to 16.
 699  *
 700  * policy instances in the ptlrpc_nrs_pol_state::NRS_POL_STATE_STOPPED state
 701  * are skipped later by nrs_crrn_ctl().
 702  */
 703 static ssize_t
 704 ptlrpc_lprocfs_nrs_crrn_quantum_seq_write(struct file *file,
 705                                           const char *buffer, size_t count,
 706                                           loff_t *off)
 707 {
 708         struct ptlrpc_service       *svc = ((struct seq_file *)file->private_data)->private;
 709         enum ptlrpc_nrs_queue_type   queue = 0;
 710         char                         kernbuf[LPROCFS_NRS_WR_QUANTUM_MAX_CMD];
 711         char                        *val;
 712         long                         quantum_reg;
 713         long                         quantum_hp;
 714         /** lprocfs_find_named_value() modifies its argument, so keep a copy */
 715         size_t                       count_copy;
 716         int                          rc = 0;
 717         int                          rc2 = 0;
 718
 719         if (count > (sizeof(kernbuf) - 1))
 720                 return -EINVAL;
 721
 722         if (copy_from_user(kernbuf, buffer, count))
 723                 return -EFAULT;
 724
 725         kernbuf[count] = '\0';
 726
 727         count_copy = count;
 728
 729         /**
 730          * Check if the regular quantum value has been specified
 731          */
 732         val = lprocfs_find_named_value(kernbuf, NRS_LPROCFS_QUANTUM_NAME_REG,
 733                                        &count_copy);
 734         if (val != kernbuf) {
 735                 quantum_reg = simple_strtol(val, NULL, 10);
 736
 737                 queue |= PTLRPC_NRS_QUEUE_REG;
 738         }
 739
 740         count_copy = count;
 741
 742         /**
 743          * Check if the high priority quantum value has been specified
 744          */
 745         val = lprocfs_find_named_value(kernbuf, NRS_LPROCFS_QUANTUM_NAME_HP,
 746                                        &count_copy);
 747         if (val != kernbuf) {
 748                 if (!nrs_svc_has_hp(svc))
 749                         return -ENODEV;
 750
 751                 quantum_hp = simple_strtol(val, NULL, 10);
 752
 753                 queue |= PTLRPC_NRS_QUEUE_HP;
 754         }
 755
 756         /**
 757          * If none of the queues has been specified, look for a valid numerical
 758          * value
 759          */
 760         if (queue == 0) {
 761                 if (!isdigit(kernbuf[0]))
 762                         return -EINVAL;
 763
 764                 quantum_reg = simple_strtol(kernbuf, NULL, 10);
 765
 766                 queue = PTLRPC_NRS_QUEUE_REG;
 767
 768                 if (nrs_svc_has_hp(svc)) {
 769                         queue |= PTLRPC_NRS_QUEUE_HP;
 770                         quantum_hp = quantum_reg;
 771                 }
 772         }
 773
 774         if ((((queue & PTLRPC_NRS_QUEUE_REG) != 0) &&
 775             ((quantum_reg > LPROCFS_NRS_QUANTUM_MAX || quantum_reg <= 0))) ||
 776             (((queue & PTLRPC_NRS_QUEUE_HP) != 0) &&
 777             ((quantum_hp > LPROCFS_NRS_QUANTUM_MAX || quantum_hp <= 0))))
 778                 return -EINVAL;
 779
 780         /**
 781          * We change the values on regular and HP NRS heads separately, so that
 782          * we do not exit early from ptlrpc_nrs_policy_control() with an error
 783          * returned by nrs_policy_ctl_locked(), in cases where the user has not
 784          * started the policy on either the regular or HP NRS head; i.e. we are
 785          * ignoring -ENODEV within nrs_policy_ctl_locked(). -ENODEV is returned
 786          * only if the operation fails with -ENODEV on all heads that have been
 787          * specified by the command; if at least one operation succeeds,
 788          * success is returned.
 789          */
 790         if ((queue & PTLRPC_NRS_QUEUE_REG) != 0) {
 791                 rc = ptlrpc_nrs_policy_control(svc, PTLRPC_NRS_QUEUE_REG,
 792                                                NRS_POL_NAME_CRRN,
 793                                                NRS_CTL_CRRN_WR_QUANTUM, false,
 794                                                &quantum_reg);
 795                 if ((rc < 0 && rc != -ENODEV) ||
 796                     (rc == -ENODEV && queue == PTLRPC_NRS_QUEUE_REG))
 797                         return rc;
 798         }
 799
 800         if ((queue & PTLRPC_NRS_QUEUE_HP) != 0) {
 801                 rc2 = ptlrpc_nrs_policy_control(svc, PTLRPC_NRS_QUEUE_HP,
 802                                                 NRS_POL_NAME_CRRN,
 803                                                 NRS_CTL_CRRN_WR_QUANTUM, false,
 804                                                 &quantum_hp);
 805                 if ((rc2 < 0 && rc2 != -ENODEV) ||
 806                     (rc2 == -ENODEV && queue == PTLRPC_NRS_QUEUE_HP))
 807                         return rc2;
 808         }
 809
 810         return rc == -ENODEV && rc2 == -ENODEV ? -ENODEV : count;
 811 }
 812 LPROC_SEQ_FOPS(ptlrpc_lprocfs_nrs_crrn_quantum);
 813
 814 /**
 815  * Initializes a CRR-N policy's lprocfs interface for service \a svc
 816  *
 817  * \param[in] svc the service
 818  *
 819  * \retval 0    success
 820  * \retval != 0 error
 821  */
 822 int nrs_crrn_lprocfs_init(struct ptlrpc_service *svc)
 823 {
 824         struct lprocfs_seq_vars nrs_crrn_lprocfs_vars[] = {
 825                 { .name         = "nrs_crrn_quantum",
 826                   .fops         = &ptlrpc_lprocfs_nrs_crrn_quantum_fops,
 827                   .data = svc },
 828                 { NULL }
 829         };
 830
 831         if (svc->srv_procroot == NULL)
 832                 return 0;
 833
 834         return lprocfs_seq_add_vars(svc->srv_procroot, nrs_crrn_lprocfs_vars,
 835                                     NULL);
 836 }
 837
 838 /**
 839  * Cleans up a CRR-N policy's lprocfs interface for service \a svc
 840  *
 841  * \param[in] svc the service
 842  */
 843 void nrs_crrn_lprocfs_fini(struct ptlrpc_service *svc)
 844 {
 845         if (svc->srv_procroot == NULL)
 846                 return;
 847
 848         lprocfs_remove_proc_entry("nrs_crrn_quantum", svc->srv_procroot);
 849 }
 850
 851 #endif /* LPROCFS */
 852
 853 /**
 854  * CRR-N policy operations
 855  */
 856 static const struct ptlrpc_nrs_pol_ops nrs_crrn_ops = {
 857         .op_policy_start        = nrs_crrn_start,
 858         .op_policy_stop         = nrs_crrn_stop,
 859         .op_policy_ctl          = nrs_crrn_ctl,
 860         .op_res_get             = nrs_crrn_res_get,
 861         .op_res_put             = nrs_crrn_res_put,
 862         .op_req_get             = nrs_crrn_req_get,
 863         .op_req_enqueue         = nrs_crrn_req_add,
 864         .op_req_dequeue         = nrs_crrn_req_del,
 865         .op_req_stop            = nrs_crrn_req_stop,
 866 #ifdef LPROCFS
 867         .op_lprocfs_init        = nrs_crrn_lprocfs_init,
 868         .op_lprocfs_fini        = nrs_crrn_lprocfs_fini,
 869 #endif
 870 };
 871
 872 /**
 873  * CRR-N policy configuration
 874  */
 875 struct ptlrpc_nrs_pol_conf nrs_conf_crrn = {
 876         .nc_name                = NRS_POL_NAME_CRRN,
 877         .nc_ops                 = &nrs_crrn_ops,
 878         .nc_compat              = nrs_policy_compat_all,
 879 };
 880
 881 /** @} CRR-N policy */
 882
 883 /** @} nrs */
 884
 885 #endif /* HAVE_SERVER_SUPPORT */