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