drivers/staging/lustre/lustre/ldlm/ldlm_pool.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.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2010, 2015, Intel Corporation.
  27  */
  28 /*
  29  * This file is part of Lustre, http://www.lustre.org/
  30  * Lustre is a trademark of Sun Microsystems, Inc.
  31  *
  32  * lustre/ldlm/ldlm_pool.c
  33  *
  34  * Author: Yury Umanets <umka@clusterfs.com>
  35  */
  36
  37 /*
  38  * Idea of this code is rather simple. Each second, for each server namespace
  39  * we have SLV - server lock volume which is calculated on current number of
  40  * granted locks, grant speed for past period, etc - that is, locking load.
  41  * This SLV number may be thought as a flow definition for simplicity. It is
  42  * sent to clients with each occasion to let them know what is current load
  43  * situation on the server. By default, at the beginning, SLV on server is
  44  * set max value which is calculated as the following: allow to one client
  45  * have all locks of limit ->pl_limit for 10h.
  46  *
  47  * Next, on clients, number of cached locks is not limited artificially in any
  48  * way as it was before. Instead, client calculates CLV, that is, client lock
  49  * volume for each lock and compares it with last SLV from the server. CLV is
  50  * calculated as the number of locks in LRU * lock live time in seconds. If
  51  * CLV > SLV - lock is canceled.
  52  *
  53  * Client has LVF, that is, lock volume factor which regulates how much
  54  * sensitive client should be about last SLV from server. The higher LVF is the
  55  * more locks will be canceled on client. Default value for it is 1. Setting LVF
  56  * to 2 means that client will cancel locks 2 times faster.
  57  *
  58  * Locks on a client will be canceled more intensively in these cases:
  59  * (1) if SLV is smaller, that is, load is higher on the server;
  60  * (2) client has a lot of locks (the more locks are held by client, the bigger
  61  *     chances that some of them should be canceled);
  62  * (3) client has old locks (taken some time ago);
  63  *
  64  * Thus, according to flow paradigm that we use for better understanding SLV,
  65  * CLV is the volume of particle in flow described by SLV. According to this,
  66  * if flow is getting thinner, more and more particles become outside of it and
  67  * as particles are locks, they should be canceled.
  68  *
  69  * General idea of this belongs to Vitaly Fertman (vitaly@clusterfs.com).
  70  * Andreas Dilger (adilger@clusterfs.com) proposed few nice ideas like using
  71  * LVF and many cleanups. Flow definition to allow more easy understanding of
  72  * the logic belongs to Nikita Danilov (nikita@clusterfs.com) as well as many
  73  * cleanups and fixes. And design and implementation are done by Yury Umanets
  74  * (umka@clusterfs.com).
  75  *
  76  * Glossary for terms used:
  77  *
  78  * pl_limit - Number of allowed locks in pool. Applies to server and client
  79  * side (tunable);
  80  *
  81  * pl_granted - Number of granted locks (calculated);
  82  * pl_grant_rate - Number of granted locks for last T (calculated);
  83  * pl_cancel_rate - Number of canceled locks for last T (calculated);
  84  * pl_grant_speed - Grant speed (GR - CR) for last T (calculated);
  85  * pl_grant_plan - Planned number of granted locks for next T (calculated);
  86  * pl_server_lock_volume - Current server lock volume (calculated);
  87  *
  88  * As it may be seen from list above, we have few possible tunables which may
  89  * affect behavior much. They all may be modified via sysfs. However, they also
  90  * give a possibility for constructing few pre-defined behavior policies. If
  91  * none of predefines is suitable for a working pattern being used, new one may
  92  * be "constructed" via sysfs tunables.
  93  */
  94
  95 #define DEBUG_SUBSYSTEM S_LDLM
  96
  97 #include <lustre_dlm.h>
  98 #include <cl_object.h>
  99 #include <obd_class.h>
 100 #include <obd_support.h>
 101 #include "ldlm_internal.h"
 102
 103 /*
 104  * 50 ldlm locks for 1MB of RAM.
 105  */
 106 #define LDLM_POOL_HOST_L ((NUM_CACHEPAGES >> (20 - PAGE_SHIFT)) * 50)
 107
 108 /*
 109  * Maximal possible grant step plan in %.
 110  */
 111 #define LDLM_POOL_MAX_GSP (30)
 112
 113 /*
 114  * Minimal possible grant step plan in %.
 115  */
 116 #define LDLM_POOL_MIN_GSP (1)
 117
 118 /*
 119  * This controls the speed of reaching LDLM_POOL_MAX_GSP
 120  * with increasing thread period.
 121  */
 122 #define LDLM_POOL_GSP_STEP_SHIFT (2)
 123
 124 /*
 125  * LDLM_POOL_GSP% of all locks is default GP.
 126  */
 127 #define LDLM_POOL_GP(L)   (((L) * LDLM_POOL_MAX_GSP) / 100)
 128
 129 /*
 130  * Max age for locks on clients.
 131  */
 132 #define LDLM_POOL_MAX_AGE (36000)
 133
 134 /*
 135  * The granularity of SLV calculation.
 136  */
 137 #define LDLM_POOL_SLV_SHIFT (10)
 138
 139 static inline __u64 dru(__u64 val, __u32 shift, int round_up)
 140 {
 141         return (val + (round_up ? (1 << shift) - 1 : 0)) >> shift;
 142 }
 143
 144 static inline __u64 ldlm_pool_slv_max(__u32 L)
 145 {
 146         /*
 147          * Allow to have all locks for 1 client for 10 hrs.
 148          * Formula is the following: limit * 10h / 1 client.
 149          */
 150         __u64 lim = (__u64)L *  LDLM_POOL_MAX_AGE / 1;
 151         return lim;
 152 }
 153
 154 static inline __u64 ldlm_pool_slv_min(__u32 L)
 155 {
 156         return 1;
 157 }
 158
 159 enum {
 160         LDLM_POOL_FIRST_STAT = 0,
 161         LDLM_POOL_GRANTED_STAT = LDLM_POOL_FIRST_STAT,
 162         LDLM_POOL_GRANT_STAT,
 163         LDLM_POOL_CANCEL_STAT,
 164         LDLM_POOL_GRANT_RATE_STAT,
 165         LDLM_POOL_CANCEL_RATE_STAT,
 166         LDLM_POOL_GRANT_PLAN_STAT,
 167         LDLM_POOL_SLV_STAT,
 168         LDLM_POOL_SHRINK_REQTD_STAT,
 169         LDLM_POOL_SHRINK_FREED_STAT,
 170         LDLM_POOL_RECALC_STAT,
 171         LDLM_POOL_TIMING_STAT,
 172         LDLM_POOL_LAST_STAT
 173 };
 174
 175 /**
 176  * Calculates suggested grant_step in % of available locks for passed
 177  * \a period. This is later used in grant_plan calculations.
 178  */
 179 static inline int ldlm_pool_t2gsp(unsigned int t)
 180 {
 181         /*
 182          * This yields 1% grant step for anything below LDLM_POOL_GSP_STEP
 183          * and up to 30% for anything higher than LDLM_POOL_GSP_STEP.
 184          *
 185          * How this will affect execution is the following:
 186          *
 187          * - for thread period 1s we will have grant_step 1% which good from
 188          * pov of taking some load off from server and push it out to clients.
 189          * This is like that because 1% for grant_step means that server will
 190          * not allow clients to get lots of locks in short period of time and
 191          * keep all old locks in their caches. Clients will always have to
 192          * get some locks back if they want to take some new;
 193          *
 194          * - for thread period 10s (which is default) we will have 23% which
 195          * means that clients will have enough of room to take some new locks
 196          * without getting some back. All locks from this 23% which were not
 197          * taken by clients in current period will contribute in SLV growing.
 198          * SLV growing means more locks cached on clients until limit or grant
 199          * plan is reached.
 200          */
 201         return LDLM_POOL_MAX_GSP -
 202                 ((LDLM_POOL_MAX_GSP - LDLM_POOL_MIN_GSP) >>
 203                  (t >> LDLM_POOL_GSP_STEP_SHIFT));
 204 }
 205
 206 /**
 207  * Recalculates next stats on passed \a pl.
 208  *
 209  * \pre ->pl_lock is locked.
 210  */
 211 static void ldlm_pool_recalc_stats(struct ldlm_pool *pl)
 212 {
 213         int grant_plan = pl->pl_grant_plan;
 214         __u64 slv = pl->pl_server_lock_volume;
 215         int granted = atomic_read(&pl->pl_granted);
 216         int grant_rate = atomic_read(&pl->pl_grant_rate);
 217         int cancel_rate = atomic_read(&pl->pl_cancel_rate);
 218
 219         lprocfs_counter_add(pl->pl_stats, LDLM_POOL_SLV_STAT,
 220                             slv);
 221         lprocfs_counter_add(pl->pl_stats, LDLM_POOL_GRANTED_STAT,
 222                             granted);
 223         lprocfs_counter_add(pl->pl_stats, LDLM_POOL_GRANT_RATE_STAT,
 224                             grant_rate);
 225         lprocfs_counter_add(pl->pl_stats, LDLM_POOL_GRANT_PLAN_STAT,
 226                             grant_plan);
 227         lprocfs_counter_add(pl->pl_stats, LDLM_POOL_CANCEL_RATE_STAT,
 228                             cancel_rate);
 229 }
 230
 231 /**
 232  * Sets SLV and Limit from container_of(pl, struct ldlm_namespace,
 233  * ns_pool)->ns_obd tp passed \a pl.
 234  */
 235 static void ldlm_cli_pool_pop_slv(struct ldlm_pool *pl)
 236 {
 237         struct obd_device *obd;
 238
 239         /*
 240          * Get new SLV and Limit from obd which is updated with coming
 241          * RPCs.
 242          */
 243         obd = container_of(pl, struct ldlm_namespace,
 244                            ns_pool)->ns_obd;
 245         read_lock(&obd->obd_pool_lock);
 246         pl->pl_server_lock_volume = obd->obd_pool_slv;
 247         atomic_set(&pl->pl_limit, obd->obd_pool_limit);
 248         read_unlock(&obd->obd_pool_lock);
 249 }
 250
 251 /**
 252  * Recalculates client size pool \a pl according to current SLV and Limit.
 253  */
 254 static int ldlm_cli_pool_recalc(struct ldlm_pool *pl)
 255 {
 256         time64_t recalc_interval_sec;
 257         int ret;
 258
 259         recalc_interval_sec = ktime_get_real_seconds() - pl->pl_recalc_time;
 260         if (recalc_interval_sec < pl->pl_recalc_period)
 261                 return 0;
 262
 263         spin_lock(&pl->pl_lock);
 264         /*
 265          * Check if we need to recalc lists now.
 266          */
 267         recalc_interval_sec = ktime_get_real_seconds() - pl->pl_recalc_time;
 268         if (recalc_interval_sec < pl->pl_recalc_period) {
 269                 spin_unlock(&pl->pl_lock);
 270                 return 0;
 271         }
 272
 273         /*
 274          * Make sure that pool knows last SLV and Limit from obd.
 275          */
 276         ldlm_cli_pool_pop_slv(pl);
 277
 278         spin_unlock(&pl->pl_lock);
 279
 280         /*
 281          * Do not cancel locks in case lru resize is disabled for this ns.
 282          */
 283         if (!ns_connect_lru_resize(container_of(pl, struct ldlm_namespace,
 284                                                 ns_pool))) {
 285                 ret = 0;
 286                 goto out;
 287         }
 288
 289         /*
 290          * In the time of canceling locks on client we do not need to maintain
 291          * sharp timing, we only want to cancel locks asap according to new SLV.
 292          * It may be called when SLV has changed much, this is why we do not
 293          * take into account pl->pl_recalc_time here.
 294          */
 295         ret = ldlm_cancel_lru(container_of(pl, struct ldlm_namespace, ns_pool),
 296                               0, LCF_ASYNC, LDLM_LRU_FLAG_LRUR);
 297
 298 out:
 299         spin_lock(&pl->pl_lock);
 300         /*
 301          * Time of LRU resizing might be longer than period,
 302          * so update after LRU resizing rather than before it.
 303          */
 304         pl->pl_recalc_time = ktime_get_real_seconds();
 305         lprocfs_counter_add(pl->pl_stats, LDLM_POOL_TIMING_STAT,
 306                             recalc_interval_sec);
 307         spin_unlock(&pl->pl_lock);
 308         return ret;
 309 }
 310
 311 /**
 312  * This function is main entry point for memory pressure handling on client
 313  * side.  Main goal of this function is to cancel some number of locks on
 314  * passed \a pl according to \a nr and \a gfp_mask.
 315  */
 316 static int ldlm_cli_pool_shrink(struct ldlm_pool *pl,
 317                                 int nr, gfp_t gfp_mask)
 318 {
 319         struct ldlm_namespace *ns;
 320         int unused;
 321
 322         ns = container_of(pl, struct ldlm_namespace, ns_pool);
 323
 324         /*
 325          * Do not cancel locks in case lru resize is disabled for this ns.
 326          */
 327         if (!ns_connect_lru_resize(ns))
 328                 return 0;
 329
 330         /*
 331          * Make sure that pool knows last SLV and Limit from obd.
 332          */
 333         ldlm_cli_pool_pop_slv(pl);
 334
 335         spin_lock(&ns->ns_lock);
 336         unused = ns->ns_nr_unused;
 337         spin_unlock(&ns->ns_lock);
 338
 339         if (nr == 0)
 340                 return (unused / 100) * sysctl_vfs_cache_pressure;
 341         else
 342                 return ldlm_cancel_lru(ns, nr, LCF_ASYNC, LDLM_LRU_FLAG_SHRINK);
 343 }
 344
 345 static const struct ldlm_pool_ops ldlm_cli_pool_ops = {
 346         .po_recalc = ldlm_cli_pool_recalc,
 347         .po_shrink = ldlm_cli_pool_shrink
 348 };
 349
 350 /**
 351  * Pool recalc wrapper. Will call either client or server pool recalc callback
 352  * depending what pool \a pl is used.
 353  */
 354 static int ldlm_pool_recalc(struct ldlm_pool *pl)
 355 {
 356         u32 recalc_interval_sec;
 357         int count;
 358
 359         recalc_interval_sec = ktime_get_real_seconds() - pl->pl_recalc_time;
 360         if (recalc_interval_sec > 0) {
 361                 spin_lock(&pl->pl_lock);
 362                 recalc_interval_sec = ktime_get_real_seconds() - pl->pl_recalc_time;
 363
 364                 if (recalc_interval_sec > 0) {
 365                         /*
 366                          * Update pool statistics every 1s.
 367                          */
 368                         ldlm_pool_recalc_stats(pl);
 369
 370                         /*
 371                          * Zero out all rates and speed for the last period.
 372                          */
 373                         atomic_set(&pl->pl_grant_rate, 0);
 374                         atomic_set(&pl->pl_cancel_rate, 0);
 375                 }
 376                 spin_unlock(&pl->pl_lock);
 377         }
 378
 379         if (pl->pl_ops->po_recalc) {
 380                 count = pl->pl_ops->po_recalc(pl);
 381                 lprocfs_counter_add(pl->pl_stats, LDLM_POOL_RECALC_STAT,
 382                                     count);
 383         }
 384
 385         recalc_interval_sec = pl->pl_recalc_time - ktime_get_real_seconds() +
 386                               pl->pl_recalc_period;
 387         if (recalc_interval_sec <= 0) {
 388                 /* DEBUG: should be re-removed after LU-4536 is fixed */
 389                 CDEBUG(D_DLMTRACE,
 390                        "%s: Negative interval(%ld), too short period(%ld)\n",
 391                        pl->pl_name, (long)recalc_interval_sec,
 392                        (long)pl->pl_recalc_period);
 393
 394                 /* Prevent too frequent recalculation. */
 395                 recalc_interval_sec = 1;
 396         }
 397
 398         return recalc_interval_sec;
 399 }
 400
 401 /*
 402  * Pool shrink wrapper. Will call either client or server pool recalc callback
 403  * depending what pool pl is used. When nr == 0, just return the number of
 404  * freeable locks. Otherwise, return the number of canceled locks.
 405  */
 406 static int ldlm_pool_shrink(struct ldlm_pool *pl, int nr, gfp_t gfp_mask)
 407 {
 408         int cancel = 0;
 409
 410         if (pl->pl_ops->po_shrink) {
 411                 cancel = pl->pl_ops->po_shrink(pl, nr, gfp_mask);
 412                 if (nr > 0) {
 413                         lprocfs_counter_add(pl->pl_stats,
 414                                             LDLM_POOL_SHRINK_REQTD_STAT,
 415                                             nr);
 416                         lprocfs_counter_add(pl->pl_stats,
 417                                             LDLM_POOL_SHRINK_FREED_STAT,
 418                                             cancel);
 419                         CDEBUG(D_DLMTRACE,
 420                                "%s: request to shrink %d locks, shrunk %d\n",
 421                                pl->pl_name, nr, cancel);
 422                 }
 423         }
 424         return cancel;
 425 }
 426
 427 static int lprocfs_pool_state_seq_show(struct seq_file *m, void *unused)
 428 {
 429         int granted, grant_rate, cancel_rate;
 430         int grant_speed, lvf;
 431         struct ldlm_pool *pl = m->private;
 432         __u64 slv, clv;
 433         __u32 limit;
 434
 435         spin_lock(&pl->pl_lock);
 436         slv = pl->pl_server_lock_volume;
 437         clv = pl->pl_client_lock_volume;
 438         limit = atomic_read(&pl->pl_limit);
 439         granted = atomic_read(&pl->pl_granted);
 440         grant_rate = atomic_read(&pl->pl_grant_rate);
 441         cancel_rate = atomic_read(&pl->pl_cancel_rate);
 442         grant_speed = grant_rate - cancel_rate;
 443         lvf = atomic_read(&pl->pl_lock_volume_factor);
 444         spin_unlock(&pl->pl_lock);
 445
 446         seq_printf(m, "LDLM pool state (%s):\n"
 447                       "  SLV: %llu\n"
 448                       "  CLV: %llu\n"
 449                       "  LVF: %d\n",
 450                       pl->pl_name, slv, clv, lvf);
 451
 452         seq_printf(m, "  GR:  %d\n  CR:  %d\n  GS:  %d\n"
 453                       "  G:   %d\n  L:   %d\n",
 454                       grant_rate, cancel_rate, grant_speed,
 455                       granted, limit);
 456
 457         return 0;
 458 }
 459
 460 LPROC_SEQ_FOPS_RO(lprocfs_pool_state);
 461
 462 static ssize_t grant_speed_show(struct kobject *kobj, struct attribute *attr,
 463                                 char *buf)
 464 {
 465         struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,
 466                                             pl_kobj);
 467
 468         int            grant_speed;
 469
 470         spin_lock(&pl->pl_lock);
 471         /* serialize with ldlm_pool_recalc */
 472         grant_speed = atomic_read(&pl->pl_grant_rate) -
 473                         atomic_read(&pl->pl_cancel_rate);
 474         spin_unlock(&pl->pl_lock);
 475         return sprintf(buf, "%d\n", grant_speed);
 476 }
 477 LUSTRE_RO_ATTR(grant_speed);
 478
 479 LDLM_POOL_SYSFS_READER_SHOW(grant_plan, int);
 480 LUSTRE_RO_ATTR(grant_plan);
 481
 482 LDLM_POOL_SYSFS_READER_SHOW(recalc_period, int);
 483 LDLM_POOL_SYSFS_WRITER_STORE(recalc_period, int);
 484 LUSTRE_RW_ATTR(recalc_period);
 485
 486 LDLM_POOL_SYSFS_READER_NOLOCK_SHOW(server_lock_volume, u64);
 487 LUSTRE_RO_ATTR(server_lock_volume);
 488
 489 LDLM_POOL_SYSFS_READER_NOLOCK_SHOW(limit, atomic);
 490 LDLM_POOL_SYSFS_WRITER_NOLOCK_STORE(limit, atomic);
 491 LUSTRE_RW_ATTR(limit);
 492
 493 LDLM_POOL_SYSFS_READER_NOLOCK_SHOW(granted, atomic);
 494 LUSTRE_RO_ATTR(granted);
 495
 496 LDLM_POOL_SYSFS_READER_NOLOCK_SHOW(cancel_rate, atomic);
 497 LUSTRE_RO_ATTR(cancel_rate);
 498
 499 LDLM_POOL_SYSFS_READER_NOLOCK_SHOW(grant_rate, atomic);
 500 LUSTRE_RO_ATTR(grant_rate);
 501
 502 LDLM_POOL_SYSFS_READER_NOLOCK_SHOW(lock_volume_factor, atomic);
 503 LDLM_POOL_SYSFS_WRITER_NOLOCK_STORE(lock_volume_factor, atomic);
 504 LUSTRE_RW_ATTR(lock_volume_factor);
 505
 506 #define LDLM_POOL_ADD_VAR(name, var, ops)                       \
 507         do {                                                    \
 508                 snprintf(var_name, MAX_STRING_SIZE, #name);     \
 509                 pool_vars[0].data = var;                        \
 510                 pool_vars[0].fops = ops;                        \
 511                 ldebugfs_add_vars(pl->pl_debugfs_entry, pool_vars, NULL);\
 512         } while (0)
 513
 514 /* These are for pools in /sys/fs/lustre/ldlm/namespaces/.../pool */
 515 static struct attribute *ldlm_pl_attrs[] = {
 516         &lustre_attr_grant_speed.attr,
 517         &lustre_attr_grant_plan.attr,
 518         &lustre_attr_recalc_period.attr,
 519         &lustre_attr_server_lock_volume.attr,
 520         &lustre_attr_limit.attr,
 521         &lustre_attr_granted.attr,
 522         &lustre_attr_cancel_rate.attr,
 523         &lustre_attr_grant_rate.attr,
 524         &lustre_attr_lock_volume_factor.attr,
 525         NULL,
 526 };
 527
 528 static void ldlm_pl_release(struct kobject *kobj)
 529 {
 530         struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,
 531                                             pl_kobj);
 532         complete(&pl->pl_kobj_unregister);
 533 }
 534
 535 static struct kobj_type ldlm_pl_ktype = {
 536         .default_attrs  = ldlm_pl_attrs,
 537         .sysfs_ops      = &lustre_sysfs_ops,
 538         .release        = ldlm_pl_release,
 539 };
 540
 541 static int ldlm_pool_sysfs_init(struct ldlm_pool *pl)
 542 {
 543         struct ldlm_namespace *ns = container_of(pl, struct ldlm_namespace,
 544                                                  ns_pool);
 545         int err;
 546
 547         init_completion(&pl->pl_kobj_unregister);
 548         err = kobject_init_and_add(&pl->pl_kobj, &ldlm_pl_ktype, &ns->ns_kobj,
 549                                    "pool");
 550
 551         return err;
 552 }
 553
 554 static int ldlm_pool_debugfs_init(struct ldlm_pool *pl)
 555 {
 556         struct ldlm_namespace *ns = container_of(pl, struct ldlm_namespace,
 557                                                  ns_pool);
 558         struct dentry *debugfs_ns_parent;
 559         struct lprocfs_vars pool_vars[2];
 560         char *var_name = NULL;
 561         int rc = 0;
 562
 563         var_name = kzalloc(MAX_STRING_SIZE + 1, GFP_NOFS);
 564         if (!var_name)
 565                 return -ENOMEM;
 566
 567         debugfs_ns_parent = ns->ns_debugfs_entry;
 568         if (IS_ERR_OR_NULL(debugfs_ns_parent)) {
 569                 CERROR("%s: debugfs entry is not initialized\n",
 570                        ldlm_ns_name(ns));
 571                 rc = -EINVAL;
 572                 goto out_free_name;
 573         }
 574         pl->pl_debugfs_entry = ldebugfs_register("pool", debugfs_ns_parent,
 575                                                  NULL, NULL);
 576         if (IS_ERR(pl->pl_debugfs_entry)) {
 577                 CERROR("LdebugFS failed in ldlm-pool-init\n");
 578                 rc = PTR_ERR(pl->pl_debugfs_entry);
 579                 pl->pl_debugfs_entry = NULL;
 580                 goto out_free_name;
 581         }
 582
 583         var_name[MAX_STRING_SIZE] = '\0';
 584         memset(pool_vars, 0, sizeof(pool_vars));
 585         pool_vars[0].name = var_name;
 586
 587         LDLM_POOL_ADD_VAR(state, pl, &lprocfs_pool_state_fops);
 588
 589         pl->pl_stats = lprocfs_alloc_stats(LDLM_POOL_LAST_STAT -
 590                                            LDLM_POOL_FIRST_STAT, 0);
 591         if (!pl->pl_stats) {
 592                 rc = -ENOMEM;
 593                 goto out_free_name;
 594         }
 595
 596         lprocfs_counter_init(pl->pl_stats, LDLM_POOL_GRANTED_STAT,
 597                              LPROCFS_CNTR_AVGMINMAX | LPROCFS_CNTR_STDDEV,
 598                              "granted", "locks");
 599         lprocfs_counter_init(pl->pl_stats, LDLM_POOL_GRANT_STAT,
 600                              LPROCFS_CNTR_AVGMINMAX | LPROCFS_CNTR_STDDEV,
 601                              "grant", "locks");
 602         lprocfs_counter_init(pl->pl_stats, LDLM_POOL_CANCEL_STAT,
 603                              LPROCFS_CNTR_AVGMINMAX | LPROCFS_CNTR_STDDEV,
 604                              "cancel", "locks");
 605         lprocfs_counter_init(pl->pl_stats, LDLM_POOL_GRANT_RATE_STAT,
 606                              LPROCFS_CNTR_AVGMINMAX | LPROCFS_CNTR_STDDEV,
 607                              "grant_rate", "locks/s");
 608         lprocfs_counter_init(pl->pl_stats, LDLM_POOL_CANCEL_RATE_STAT,
 609                              LPROCFS_CNTR_AVGMINMAX | LPROCFS_CNTR_STDDEV,
 610                              "cancel_rate", "locks/s");
 611         lprocfs_counter_init(pl->pl_stats, LDLM_POOL_GRANT_PLAN_STAT,
 612                              LPROCFS_CNTR_AVGMINMAX | LPROCFS_CNTR_STDDEV,
 613                              "grant_plan", "locks/s");
 614         lprocfs_counter_init(pl->pl_stats, LDLM_POOL_SLV_STAT,
 615                              LPROCFS_CNTR_AVGMINMAX | LPROCFS_CNTR_STDDEV,
 616                              "slv", "slv");
 617         lprocfs_counter_init(pl->pl_stats, LDLM_POOL_SHRINK_REQTD_STAT,
 618                              LPROCFS_CNTR_AVGMINMAX | LPROCFS_CNTR_STDDEV,
 619                              "shrink_request", "locks");
 620         lprocfs_counter_init(pl->pl_stats, LDLM_POOL_SHRINK_FREED_STAT,
 621                              LPROCFS_CNTR_AVGMINMAX | LPROCFS_CNTR_STDDEV,
 622                              "shrink_freed", "locks");
 623         lprocfs_counter_init(pl->pl_stats, LDLM_POOL_RECALC_STAT,
 624                              LPROCFS_CNTR_AVGMINMAX | LPROCFS_CNTR_STDDEV,
 625                              "recalc_freed", "locks");
 626         lprocfs_counter_init(pl->pl_stats, LDLM_POOL_TIMING_STAT,
 627                              LPROCFS_CNTR_AVGMINMAX | LPROCFS_CNTR_STDDEV,
 628                              "recalc_timing", "sec");
 629         rc = ldebugfs_register_stats(pl->pl_debugfs_entry, "stats",
 630                                      pl->pl_stats);
 631
 632 out_free_name:
 633         kfree(var_name);
 634         return rc;
 635 }
 636
 637 static void ldlm_pool_sysfs_fini(struct ldlm_pool *pl)
 638 {
 639         kobject_put(&pl->pl_kobj);
 640         wait_for_completion(&pl->pl_kobj_unregister);
 641 }
 642
 643 static void ldlm_pool_debugfs_fini(struct ldlm_pool *pl)
 644 {
 645         if (pl->pl_stats) {
 646                 lprocfs_free_stats(&pl->pl_stats);
 647                 pl->pl_stats = NULL;
 648         }
 649         if (pl->pl_debugfs_entry) {
 650                 ldebugfs_remove(&pl->pl_debugfs_entry);
 651                 pl->pl_debugfs_entry = NULL;
 652         }
 653 }
 654
 655 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
 656                    int idx, enum ldlm_side client)
 657 {
 658         int rc;
 659
 660         spin_lock_init(&pl->pl_lock);
 661         atomic_set(&pl->pl_granted, 0);
 662         pl->pl_recalc_time = ktime_get_real_seconds();
 663         atomic_set(&pl->pl_lock_volume_factor, 1);
 664
 665         atomic_set(&pl->pl_grant_rate, 0);
 666         atomic_set(&pl->pl_cancel_rate, 0);
 667         pl->pl_grant_plan = LDLM_POOL_GP(LDLM_POOL_HOST_L);
 668
 669         snprintf(pl->pl_name, sizeof(pl->pl_name), "ldlm-pool-%s-%d",
 670                  ldlm_ns_name(ns), idx);
 671
 672         atomic_set(&pl->pl_limit, 1);
 673         pl->pl_server_lock_volume = 0;
 674         pl->pl_ops = &ldlm_cli_pool_ops;
 675         pl->pl_recalc_period = LDLM_POOL_CLI_DEF_RECALC_PERIOD;
 676         pl->pl_client_lock_volume = 0;
 677         rc = ldlm_pool_debugfs_init(pl);
 678         if (rc)
 679                 return rc;
 680
 681         rc = ldlm_pool_sysfs_init(pl);
 682         if (rc)
 683                 return rc;
 684
 685         CDEBUG(D_DLMTRACE, "Lock pool %s is initialized\n", pl->pl_name);
 686
 687         return rc;
 688 }
 689
 690 void ldlm_pool_fini(struct ldlm_pool *pl)
 691 {
 692         ldlm_pool_sysfs_fini(pl);
 693         ldlm_pool_debugfs_fini(pl);
 694
 695         /*
 696          * Pool should not be used after this point. We can't free it here as
 697          * it lives in struct ldlm_namespace, but still interested in catching
 698          * any abnormal using cases.
 699          */
 700         POISON(pl, 0x5a, sizeof(*pl));
 701 }
 702
 703 /**
 704  * Add new taken ldlm lock \a lock into pool \a pl accounting.
 705  */
 706 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock)
 707 {
 708         /*
 709          * FLOCK locks are special in a sense that they are almost never
 710          * cancelled, instead special kind of lock is used to drop them.
 711          * also there is no LRU for flock locks, so no point in tracking
 712          * them anyway.
 713          */
 714         if (lock->l_resource->lr_type == LDLM_FLOCK)
 715                 return;
 716
 717         atomic_inc(&pl->pl_granted);
 718         atomic_inc(&pl->pl_grant_rate);
 719         lprocfs_counter_incr(pl->pl_stats, LDLM_POOL_GRANT_STAT);
 720         /*
 721          * Do not do pool recalc for client side as all locks which
 722          * potentially may be canceled has already been packed into
 723          * enqueue/cancel rpc. Also we do not want to run out of stack
 724          * with too long call paths.
 725          */
 726 }
 727
 728 /**
 729  * Remove ldlm lock \a lock from pool \a pl accounting.
 730  */
 731 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock)
 732 {
 733         /*
 734          * Filter out FLOCK locks. Read above comment in ldlm_pool_add().
 735          */
 736         if (lock->l_resource->lr_type == LDLM_FLOCK)
 737                 return;
 738
 739         LASSERT(atomic_read(&pl->pl_granted) > 0);
 740         atomic_dec(&pl->pl_granted);
 741         atomic_inc(&pl->pl_cancel_rate);
 742
 743         lprocfs_counter_incr(pl->pl_stats, LDLM_POOL_CANCEL_STAT);
 744 }
 745
 746 /**
 747  * Returns current \a pl SLV.
 748  *
 749  * \pre ->pl_lock is not locked.
 750  */
 751 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl)
 752 {
 753         __u64 slv;
 754
 755         spin_lock(&pl->pl_lock);
 756         slv = pl->pl_server_lock_volume;
 757         spin_unlock(&pl->pl_lock);
 758         return slv;
 759 }
 760
 761 /**
 762  * Sets passed \a clv to \a pl.
 763  *
 764  * \pre ->pl_lock is not locked.
 765  */
 766 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv)
 767 {
 768         spin_lock(&pl->pl_lock);
 769         pl->pl_client_lock_volume = clv;
 770         spin_unlock(&pl->pl_lock);
 771 }
 772
 773 /**
 774  * Returns current LVF from \a pl.
 775  */
 776 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl)
 777 {
 778         return atomic_read(&pl->pl_lock_volume_factor);
 779 }
 780
 781 static int ldlm_pool_granted(struct ldlm_pool *pl)
 782 {
 783         return atomic_read(&pl->pl_granted);
 784 }
 785
 786 static struct ptlrpc_thread *ldlm_pools_thread;
 787 static struct completion ldlm_pools_comp;
 788
 789 /*
 790  * count locks from all namespaces (if possible). Returns number of
 791  * cached locks.
 792  */
 793 static unsigned long ldlm_pools_count(enum ldlm_side client, gfp_t gfp_mask)
 794 {
 795         unsigned long total = 0;
 796         int nr_ns;
 797         struct ldlm_namespace *ns;
 798         struct ldlm_namespace *ns_old = NULL; /* loop detection */
 799
 800         if (client == LDLM_NAMESPACE_CLIENT && !(gfp_mask & __GFP_FS))
 801                 return 0;
 802
 803         CDEBUG(D_DLMTRACE, "Request to count %s locks from all pools\n",
 804                client == LDLM_NAMESPACE_CLIENT ? "client" : "server");
 805
 806         /*
 807          * Find out how many resources we may release.
 808          */
 809         for (nr_ns = ldlm_namespace_nr_read(client);
 810              nr_ns > 0; nr_ns--) {
 811                 mutex_lock(ldlm_namespace_lock(client));
 812                 if (list_empty(ldlm_namespace_list(client))) {
 813                         mutex_unlock(ldlm_namespace_lock(client));
 814                         return 0;
 815                 }
 816                 ns = ldlm_namespace_first_locked(client);
 817
 818                 if (ns == ns_old) {
 819                         mutex_unlock(ldlm_namespace_lock(client));
 820                         break;
 821                 }
 822
 823                 if (ldlm_ns_empty(ns)) {
 824                         ldlm_namespace_move_to_inactive_locked(ns, client);
 825                         mutex_unlock(ldlm_namespace_lock(client));
 826                         continue;
 827                 }
 828
 829                 if (!ns_old)
 830                         ns_old = ns;
 831
 832                 ldlm_namespace_get(ns);
 833                 ldlm_namespace_move_to_active_locked(ns, client);
 834                 mutex_unlock(ldlm_namespace_lock(client));
 835                 total += ldlm_pool_shrink(&ns->ns_pool, 0, gfp_mask);
 836                 ldlm_namespace_put(ns);
 837         }
 838
 839         return total;
 840 }
 841
 842 static unsigned long ldlm_pools_scan(enum ldlm_side client, int nr,
 843                                      gfp_t gfp_mask)
 844 {
 845         unsigned long freed = 0;
 846         int tmp, nr_ns;
 847         struct ldlm_namespace *ns;
 848
 849         if (client == LDLM_NAMESPACE_CLIENT && !(gfp_mask & __GFP_FS))
 850                 return -1;
 851
 852         /*
 853          * Shrink at least ldlm_namespace_nr_read(client) namespaces.
 854          */
 855         for (tmp = nr_ns = ldlm_namespace_nr_read(client);
 856              tmp > 0; tmp--) {
 857                 int cancel, nr_locks;
 858
 859                 /*
 860                  * Do not call shrink under ldlm_namespace_lock(client)
 861                  */
 862                 mutex_lock(ldlm_namespace_lock(client));
 863                 if (list_empty(ldlm_namespace_list(client))) {
 864                         mutex_unlock(ldlm_namespace_lock(client));
 865                         break;
 866                 }
 867                 ns = ldlm_namespace_first_locked(client);
 868                 ldlm_namespace_get(ns);
 869                 ldlm_namespace_move_to_active_locked(ns, client);
 870                 mutex_unlock(ldlm_namespace_lock(client));
 871
 872                 nr_locks = ldlm_pool_granted(&ns->ns_pool);
 873                 /*
 874                  * We use to shrink propotionally but with new shrinker API,
 875                  * we lost the total number of freeable locks.
 876                  */
 877                 cancel = 1 + min_t(int, nr_locks, nr / nr_ns);
 878                 freed += ldlm_pool_shrink(&ns->ns_pool, cancel, gfp_mask);
 879                 ldlm_namespace_put(ns);
 880         }
 881         /*
 882          * we only decrease the SLV in server pools shrinker, return
 883          * SHRINK_STOP to kernel to avoid needless loop. LU-1128
 884          */
 885         return freed;
 886 }
 887
 888 static unsigned long ldlm_pools_cli_count(struct shrinker *s,
 889                                           struct shrink_control *sc)
 890 {
 891         return ldlm_pools_count(LDLM_NAMESPACE_CLIENT, sc->gfp_mask);
 892 }
 893
 894 static unsigned long ldlm_pools_cli_scan(struct shrinker *s,
 895                                          struct shrink_control *sc)
 896 {
 897         return ldlm_pools_scan(LDLM_NAMESPACE_CLIENT, sc->nr_to_scan,
 898                                sc->gfp_mask);
 899 }
 900
 901 static int ldlm_pools_recalc(enum ldlm_side client)
 902 {
 903         struct ldlm_namespace *ns;
 904         struct ldlm_namespace *ns_old = NULL;
 905         /* seconds of sleep if no active namespaces */
 906         int time = LDLM_POOL_CLI_DEF_RECALC_PERIOD;
 907         int nr;
 908
 909         /*
 910          * Recalc at least ldlm_namespace_nr_read(client) namespaces.
 911          */
 912         for (nr = ldlm_namespace_nr_read(client); nr > 0; nr--) {
 913                 int     skip;
 914                 /*
 915                  * Lock the list, get first @ns in the list, getref, move it
 916                  * to the tail, unlock and call pool recalc. This way we avoid
 917                  * calling recalc under @ns lock what is really good as we get
 918                  * rid of potential deadlock on client nodes when canceling
 919                  * locks synchronously.
 920                  */
 921                 mutex_lock(ldlm_namespace_lock(client));
 922                 if (list_empty(ldlm_namespace_list(client))) {
 923                         mutex_unlock(ldlm_namespace_lock(client));
 924                         break;
 925                 }
 926                 ns = ldlm_namespace_first_locked(client);
 927
 928                 if (ns_old == ns) { /* Full pass complete */
 929                         mutex_unlock(ldlm_namespace_lock(client));
 930                         break;
 931                 }
 932
 933                 /* We got an empty namespace, need to move it back to inactive
 934                  * list.
 935                  * The race with parallel resource creation is fine:
 936                  * - If they do namespace_get before our check, we fail the
 937                  *   check and they move this item to the end of the list anyway
 938                  * - If we do the check and then they do namespace_get, then
 939                  *   we move the namespace to inactive and they will move
 940                  *   it back to active (synchronised by the lock, so no clash
 941                  *   there).
 942                  */
 943                 if (ldlm_ns_empty(ns)) {
 944                         ldlm_namespace_move_to_inactive_locked(ns, client);
 945                         mutex_unlock(ldlm_namespace_lock(client));
 946                         continue;
 947                 }
 948
 949                 if (!ns_old)
 950                         ns_old = ns;
 951
 952                 spin_lock(&ns->ns_lock);
 953                 /*
 954                  * skip ns which is being freed, and we don't want to increase
 955                  * its refcount again, not even temporarily. bz21519 & LU-499.
 956                  */
 957                 if (ns->ns_stopping) {
 958                         skip = 1;
 959                 } else {
 960                         skip = 0;
 961                         ldlm_namespace_get(ns);
 962                 }
 963                 spin_unlock(&ns->ns_lock);
 964
 965                 ldlm_namespace_move_to_active_locked(ns, client);
 966                 mutex_unlock(ldlm_namespace_lock(client));
 967
 968                 /*
 969                  * After setup is done - recalc the pool.
 970                  */
 971                 if (!skip) {
 972                         int ttime = ldlm_pool_recalc(&ns->ns_pool);
 973
 974                         if (ttime < time)
 975                                 time = ttime;
 976
 977                         ldlm_namespace_put(ns);
 978                 }
 979         }
 980
 981         /* Wake up the blocking threads from time to time. */
 982         ldlm_bl_thread_wakeup();
 983
 984         return time;
 985 }
 986
 987 static int ldlm_pools_thread_main(void *arg)
 988 {
 989         struct ptlrpc_thread *thread = (struct ptlrpc_thread *)arg;
 990         int c_time;
 991
 992         thread_set_flags(thread, SVC_RUNNING);
 993         wake_up(&thread->t_ctl_waitq);
 994
 995         CDEBUG(D_DLMTRACE, "%s: pool thread starting, process %d\n",
 996                "ldlm_poold", current_pid());
 997
 998         while (1) {
 999                 struct l_wait_info lwi;
1000
1001                 /*
1002                  * Recal all pools on this tick.
1003                  */
1004                 c_time = ldlm_pools_recalc(LDLM_NAMESPACE_CLIENT);
1005
1006                 /*
1007                  * Wait until the next check time, or until we're
1008                  * stopped.
1009                  */
1010                 lwi = LWI_TIMEOUT(cfs_time_seconds(c_time),
1011                                   NULL, NULL);
1012                 l_wait_event(thread->t_ctl_waitq,
1013                              thread_is_stopping(thread) ||
1014                              thread_is_event(thread),
1015                              &lwi);
1016
1017                 if (thread_test_and_clear_flags(thread, SVC_STOPPING))
1018                         break;
1019                 thread_test_and_clear_flags(thread, SVC_EVENT);
1020         }
1021
1022         thread_set_flags(thread, SVC_STOPPED);
1023         wake_up(&thread->t_ctl_waitq);
1024
1025         CDEBUG(D_DLMTRACE, "%s: pool thread exiting, process %d\n",
1026                "ldlm_poold", current_pid());
1027
1028         complete_and_exit(&ldlm_pools_comp, 0);
1029 }
1030
1031 static int ldlm_pools_thread_start(void)
1032 {
1033         struct l_wait_info lwi = { 0 };
1034         struct task_struct *task;
1035
1036         if (ldlm_pools_thread)
1037                 return -EALREADY;
1038
1039         ldlm_pools_thread = kzalloc(sizeof(*ldlm_pools_thread), GFP_NOFS);
1040         if (!ldlm_pools_thread)
1041                 return -ENOMEM;
1042
1043         init_completion(&ldlm_pools_comp);
1044         init_waitqueue_head(&ldlm_pools_thread->t_ctl_waitq);
1045
1046         task = kthread_run(ldlm_pools_thread_main, ldlm_pools_thread,
1047                            "ldlm_poold");
1048         if (IS_ERR(task)) {
1049                 CERROR("Can't start pool thread, error %ld\n", PTR_ERR(task));
1050                 kfree(ldlm_pools_thread);
1051                 ldlm_pools_thread = NULL;
1052                 return PTR_ERR(task);
1053         }
1054         l_wait_event(ldlm_pools_thread->t_ctl_waitq,
1055                      thread_is_running(ldlm_pools_thread), &lwi);
1056         return 0;
1057 }
1058
1059 static void ldlm_pools_thread_stop(void)
1060 {
1061         if (!ldlm_pools_thread)
1062                 return;
1063
1064         thread_set_flags(ldlm_pools_thread, SVC_STOPPING);
1065         wake_up(&ldlm_pools_thread->t_ctl_waitq);
1066
1067         /*
1068          * Make sure that pools thread is finished before freeing @thread.
1069          * This fixes possible race and oops due to accessing freed memory
1070          * in pools thread.
1071          */
1072         wait_for_completion(&ldlm_pools_comp);
1073         kfree(ldlm_pools_thread);
1074         ldlm_pools_thread = NULL;
1075 }
1076
1077 static struct shrinker ldlm_pools_cli_shrinker = {
1078         .count_objects  = ldlm_pools_cli_count,
1079         .scan_objects   = ldlm_pools_cli_scan,
1080         .seeks          = DEFAULT_SEEKS,
1081 };
1082
1083 int ldlm_pools_init(void)
1084 {
1085         int rc;
1086
1087         rc = ldlm_pools_thread_start();
1088         if (rc == 0)
1089                 register_shrinker(&ldlm_pools_cli_shrinker);
1090
1091         return rc;
1092 }
1093
1094 void ldlm_pools_fini(void)
1095 {
1096         if (ldlm_pools_thread)
1097                 unregister_shrinker(&ldlm_pools_cli_shrinker);
1098
1099         ldlm_pools_thread_stop();
1100 }