lustre/ldlm/ldlm_internal.h

   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) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Use is subject to license terms.
  25  *
  26  * Copyright (c) 2011, 2017, 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
  33 extern int ldlm_srv_namespace_nr;
  34 extern int ldlm_cli_namespace_nr;
  35 extern struct mutex ldlm_srv_namespace_lock;
  36 extern struct list_head ldlm_srv_namespace_list;
  37 extern struct mutex ldlm_cli_namespace_lock;
  38 extern struct list_head ldlm_cli_active_namespace_list;
  39 extern struct list_head ldlm_cli_inactive_namespace_list;
  40 extern unsigned int ldlm_cancel_unused_locks_before_replay;
  41 extern struct kmem_cache *ldlm_glimpse_work_kmem;
  42
  43 static inline int ldlm_namespace_nr_read(enum ldlm_side client)
  44 {
  45         return client == LDLM_NAMESPACE_SERVER ?
  46                 ldlm_srv_namespace_nr : ldlm_cli_namespace_nr;
  47 }
  48
  49 static inline void ldlm_namespace_nr_inc(enum ldlm_side client)
  50 {
  51         if (client == LDLM_NAMESPACE_SERVER)
  52                 ldlm_srv_namespace_nr++;
  53         else
  54                 ldlm_cli_namespace_nr++;
  55 }
  56
  57 static inline void ldlm_namespace_nr_dec(enum ldlm_side client)
  58 {
  59         if (client == LDLM_NAMESPACE_SERVER)
  60                 ldlm_srv_namespace_nr--;
  61         else
  62                 ldlm_cli_namespace_nr--;
  63 }
  64
  65 static inline struct list_head *ldlm_namespace_list(enum ldlm_side client)
  66 {
  67         return client == LDLM_NAMESPACE_SERVER ?
  68                 &ldlm_srv_namespace_list : &ldlm_cli_active_namespace_list;
  69 }
  70
  71 static inline
  72 struct list_head *ldlm_namespace_inactive_list(enum ldlm_side client)
  73 {
  74         return client == LDLM_NAMESPACE_SERVER ?
  75                 &ldlm_srv_namespace_list : &ldlm_cli_inactive_namespace_list;
  76 }
  77
  78 static inline struct mutex *ldlm_namespace_lock(enum ldlm_side client)
  79 {
  80         return client == LDLM_NAMESPACE_SERVER ?
  81                 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
  82 }
  83
  84 /* ns_bref is the number of resources in this namespace */
  85 static inline int ldlm_ns_empty(struct ldlm_namespace *ns)
  86 {
  87         return atomic_read(&ns->ns_bref) == 0;
  88 }
  89
  90 void ldlm_namespace_move_to_active_locked(struct ldlm_namespace *,
  91                                           enum ldlm_side);
  92 void ldlm_namespace_move_to_inactive_locked(struct ldlm_namespace *,
  93                                             enum ldlm_side);
  94 struct ldlm_namespace *ldlm_namespace_first_locked(enum ldlm_side);
  95
  96 /* ldlm_request.c */
  97 /* Cancel lru flag, it indicates we cancel aged locks. */
  98 enum ldlm_lru_flags {
  99         LDLM_LRU_FLAG_AGED      = 0x01, /* Cancel aged locks (non LRU resize) */
 100         LDLM_LRU_FLAG_PASSED    = 0x02, /* Cancel passed number of locks */
 101         LDLM_LRU_FLAG_SHRINK    = 0x04, /* Cancel locks from shrinker */
 102         LDLM_LRU_FLAG_LRUR      = 0x08, /* Cancel locks from lru resize */
 103         LDLM_LRU_FLAG_NO_WAIT   = 0x10, /* Cancel locks w/o blocking (neither
 104                                          * sending nor waiting for any RPCs) */
 105         LDLM_LRU_FLAG_CLEANUP   = 0x20, /* Used when clearing lru, tells
 106                                          * prepare_lru_list to set discard flag
 107                                          * on PR extent locks so we don't waste
 108                                          * time saving pages that will be
 109                                          * discarded momentarily */
 110 };
 111
 112 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr,
 113                     enum ldlm_cancel_flags cancel_flags,
 114                     enum ldlm_lru_flags lru_flags);
 115 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
 116                           struct list_head *cancels, int count, int max,
 117                           enum ldlm_cancel_flags cancel_flags,
 118                           enum ldlm_lru_flags lru_flags);
 119 extern unsigned int ldlm_enqueue_min;
 120 /* ldlm_resource.c */
 121 extern struct kmem_cache *ldlm_resource_slab;
 122 extern struct kmem_cache *ldlm_lock_slab;
 123 extern struct kmem_cache *ldlm_inodebits_slab;
 124 extern struct kmem_cache *ldlm_interval_tree_slab;
 125
 126 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
 127                                      struct ldlm_lock *new);
 128 void ldlm_resource_insert_lock_before(struct ldlm_lock *original,
 129                                       struct ldlm_lock *new);
 130
 131 /* ldlm_lock.c */
 132
 133 typedef enum {
 134         LDLM_WORK_BL_AST,
 135         LDLM_WORK_CP_AST,
 136         LDLM_WORK_REVOKE_AST,
 137         LDLM_WORK_GL_AST
 138 } ldlm_desc_ast_t;
 139
 140 void ldlm_grant_lock_with_skiplist(struct ldlm_lock *lock);
 141 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
 142 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
 143                   enum req_location loc, void *data, int size);
 144 struct ldlm_lock *
 145 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
 146                  enum ldlm_type type, enum ldlm_mode mode,
 147                  const struct ldlm_callback_suite *cbs,
 148                  void *data, __u32 lvb_len, enum lvb_type lvb_type);
 149 enum ldlm_error ldlm_lock_enqueue(const struct lu_env *env,
 150                                   struct ldlm_namespace *,
 151                                   struct ldlm_lock **,
 152                                   void *cookie, __u64 *flags);
 153 void ldlm_lock_addref_internal(struct ldlm_lock *, enum ldlm_mode mode);
 154 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
 155 void ldlm_lock_decref_internal(struct ldlm_lock *, enum ldlm_mode mode);
 156 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
 157 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
 158                             struct list_head *work_list);
 159 #ifdef HAVE_SERVER_SUPPORT
 160 int ldlm_reprocess_queue(struct ldlm_resource *res, struct list_head *queue,
 161                          struct list_head *work_list,
 162                          enum ldlm_process_intention intention,
 163                          struct ldlm_lock *hint);
 164 int ldlm_handle_conflict_lock(struct ldlm_lock *lock, __u64 *flags,
 165                               struct list_head *rpc_list);
 166 void ldlm_discard_bl_list(struct list_head *bl_list);
 167 void ldlm_clear_blocking_lock(struct ldlm_lock *lock);
 168 void ldlm_clear_blocking_data(struct ldlm_lock *lock);
 169 #endif
 170 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
 171                       ldlm_desc_ast_t ast_type);
 172 int ldlm_work_gl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq);
 173 int ldlm_lock_remove_from_lru_check(struct ldlm_lock *lock, ktime_t last_use);
 174 #define ldlm_lock_remove_from_lru(lock) \
 175                 ldlm_lock_remove_from_lru_check(lock, ktime_set(0, 0))
 176 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
 177 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
 178 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
 179 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
 180 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
 181
 182 int ldlm_export_cancel_blocked_locks(struct obd_export *exp);
 183 int ldlm_export_cancel_locks(struct obd_export *exp);
 184 void ldlm_grant_lock_with_skiplist(struct ldlm_lock *lock);
 185
 186 /* ldlm_lockd.c */
 187 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
 188                            struct ldlm_lock *lock);
 189 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns,
 190                            struct ldlm_lock_desc *ld,
 191                            struct list_head *cancels, int count,
 192                            enum ldlm_cancel_flags cancel_flags);
 193 int ldlm_bl_thread_wakeup(void);
 194
 195 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
 196                              struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
 197 void ldlm_bl_desc2lock(const struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
 198
 199 #ifdef HAVE_SERVER_SUPPORT
 200 /* ldlm_plain.c */
 201 int ldlm_process_plain_lock(struct ldlm_lock *lock, __u64 *flags,
 202                             enum ldlm_process_intention intention,
 203                             enum ldlm_error *err, struct list_head *work_list);
 204
 205 /* ldlm_inodebits.c */
 206 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
 207                                 enum ldlm_process_intention intention,
 208                                 enum ldlm_error *err,
 209                                 struct list_head *work_list);
 210 int ldlm_reprocess_inodebits_queue(struct ldlm_resource *res,
 211                                    struct list_head *queue,
 212                                    struct list_head *work_list,
 213                                    enum ldlm_process_intention intention,
 214                                    struct ldlm_lock *hint);
 215 /* ldlm_extent.c */
 216 int ldlm_process_extent_lock(struct ldlm_lock *lock, __u64 *flags,
 217                              enum ldlm_process_intention intention,
 218                              enum ldlm_error *err, struct list_head *work_list);
 219 #endif
 220 int ldlm_extent_alloc_lock(struct ldlm_lock *lock);
 221 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
 222 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
 223
 224 int ldlm_inodebits_alloc_lock(struct ldlm_lock *lock);
 225 void ldlm_inodebits_add_lock(struct ldlm_resource *res, struct list_head *head,
 226                              struct ldlm_lock *lock);
 227 void ldlm_inodebits_unlink_lock(struct ldlm_lock *lock);
 228
 229 /* ldlm_flock.c */
 230 int ldlm_process_flock_lock(struct ldlm_lock *req, __u64 *flags,
 231                             enum ldlm_process_intention intention,
 232                             enum ldlm_error *err, struct list_head *work_list);
 233 int ldlm_init_flock_export(struct obd_export *exp);
 234 void ldlm_destroy_flock_export(struct obd_export *exp);
 235
 236 /* l_lock.c */
 237 void l_check_ns_lock(struct ldlm_namespace *ns);
 238 void l_check_no_ns_lock(struct ldlm_namespace *ns);
 239
 240 extern struct dentry *ldlm_svc_debugfs_dir;
 241
 242 struct ldlm_state {
 243         struct ptlrpc_service *ldlm_cb_service;
 244         struct ptlrpc_service *ldlm_cancel_service;
 245         struct ptlrpc_client *ldlm_client;
 246         struct ldlm_bl_pool *ldlm_bl_pool;
 247 };
 248
 249 /* interval tree, for LDLM_EXTENT. */
 250 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
 251 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
 252 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
 253 extern void ldlm_interval_free(struct ldlm_interval *node);
 254 /* this function must be called with res lock held */
 255 static inline struct ldlm_extent *
 256 ldlm_interval_extent(struct ldlm_interval *node)
 257 {
 258         struct ldlm_lock *lock;
 259         LASSERT(!list_empty(&node->li_group));
 260
 261         lock = list_entry(node->li_group.next, struct ldlm_lock,
 262                               l_sl_policy);
 263         return &lock->l_policy_data.l_extent;
 264 }
 265
 266 int ldlm_init(void);
 267 void ldlm_exit(void);
 268
 269 enum ldlm_policy_res {
 270         LDLM_POLICY_CANCEL_LOCK,
 271         LDLM_POLICY_KEEP_LOCK,
 272         LDLM_POLICY_SKIP_LOCK
 273 };
 274
 275 #define LDLM_POOL_SYSFS_PRINT_int(v) sprintf(buf, "%d\n", v)
 276 #define LDLM_POOL_SYSFS_SET_int(a, b) { a = b; }
 277 #define LDLM_POOL_SYSFS_PRINT_u64(v) sprintf(buf, "%lld\n", v)
 278 #define LDLM_POOL_SYSFS_SET_u64(a, b) { a = b; }
 279 #define LDLM_POOL_SYSFS_PRINT_atomic(v) sprintf(buf, "%d\n", atomic_read(&v))
 280 #define LDLM_POOL_SYSFS_SET_atomic(a, b) atomic_set(&a, b)
 281
 282 #define LDLM_POOL_SYSFS_READER_SHOW(var, type)                             \
 283         static ssize_t var##_show(struct kobject *kobj,                    \
 284                                   struct attribute *attr,                  \
 285                                   char *buf)                               \
 286         {                                                                  \
 287                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
 288                                                     pl_kobj);              \
 289                 type tmp;                                                  \
 290                                                                            \
 291                 spin_lock(&pl->pl_lock);                                   \
 292                 tmp = pl->pl_##var;                                        \
 293                 spin_unlock(&pl->pl_lock);                                 \
 294                                                                            \
 295                 return LDLM_POOL_SYSFS_PRINT_##type(tmp);                  \
 296         }                                                                  \
 297         struct __##var##__dummy_read {;} /* semicolon catcher */
 298
 299 #define LDLM_POOL_SYSFS_WRITER_STORE(var, type)                            \
 300         static ssize_t var##_store(struct kobject *kobj,                   \
 301                                    struct attribute *attr,                 \
 302                                    const char *buffer,                     \
 303                                    size_t count)                           \
 304         {                                                                  \
 305                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
 306                                                     pl_kobj);              \
 307                 unsigned long tmp;                                         \
 308                 int rc;                                                    \
 309                                                                            \
 310                 rc = kstrtoul(buffer, 10, &tmp);                           \
 311                 if (rc < 0) {                                              \
 312                         return rc;                                         \
 313                 }                                                          \
 314                                                                            \
 315                 spin_lock(&pl->pl_lock);                                   \
 316                 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp);             \
 317                 spin_unlock(&pl->pl_lock);                                 \
 318                                                                            \
 319                 return count;                                              \
 320         }                                                                  \
 321         struct __##var##__dummy_write {; } /* semicolon catcher */
 322
 323 #define LDLM_POOL_SYSFS_READER_NOLOCK_SHOW(var, type)                      \
 324         static ssize_t var##_show(struct kobject *kobj,                    \
 325                                   struct attribute *attr,                  \
 326                                   char *buf)                               \
 327         {                                                                  \
 328                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
 329                                                     pl_kobj);              \
 330                                                                            \
 331                 return LDLM_POOL_SYSFS_PRINT_##type(pl->pl_##var);         \
 332         }                                                                  \
 333         struct __##var##__dummy_read {; } /* semicolon catcher */
 334
 335 #define LDLM_POOL_SYSFS_WRITER_NOLOCK_STORE(var, type)                     \
 336         static ssize_t var##_store(struct kobject *kobj,                   \
 337                                    struct attribute *attr,                 \
 338                                    const char *buffer,                     \
 339                                    size_t count)                           \
 340         {                                                                  \
 341                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
 342                                                     pl_kobj);              \
 343                 unsigned long tmp;                                         \
 344                 int rc;                                                    \
 345                                                                            \
 346                 rc = kstrtoul(buffer, 10, &tmp);                           \
 347                 if (rc < 0) {                                              \
 348                         return rc;                                         \
 349                 }                                                          \
 350                                                                            \
 351                 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp);             \
 352                                                                            \
 353                 return count;                                              \
 354         }                                                                  \
 355         struct __##var##__dummy_write {; } /* semicolon catcher */
 356
 357 static inline void
 358 ldlm_add_var(struct ldebugfs_vars *vars, struct dentry *debugfs_entry,
 359              const char *name, void *data, const struct file_operations *ops)
 360 {
 361         vars->name = name;
 362         vars->data = data;
 363         vars->fops = ops;
 364         ldebugfs_add_vars(debugfs_entry, vars, NULL);
 365 }
 366
 367 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
 368 {
 369         int ret = 0;
 370
 371         lock_res_and_lock(lock);
 372         ret = is_granted_or_cancelled_nolock(lock);
 373         unlock_res_and_lock(lock);
 374
 375         return ret;
 376 }
 377
 378 static inline bool is_bl_done(struct ldlm_lock *lock)
 379 {
 380         bool bl_done = true;
 381
 382         if (!ldlm_is_bl_done(lock)) {
 383                 lock_res_and_lock(lock);
 384                 bl_done = ldlm_is_bl_done(lock);
 385                 unlock_res_and_lock(lock);
 386         }
 387
 388         return bl_done;
 389 }
 390
 391 static inline bool is_lock_converted(struct ldlm_lock *lock)
 392 {
 393         bool ret = 0;
 394
 395         lock_res_and_lock(lock);
 396         ret = (lock->l_policy_data.l_inodebits.cancel_bits == 0);
 397         unlock_res_and_lock(lock);
 398
 399         return ret;
 400 }
 401
 402 typedef void (*ldlm_policy_wire_to_local_t)(const union ldlm_wire_policy_data *,
 403                                             union ldlm_policy_data *);
 404 typedef void (*ldlm_policy_local_to_wire_t)(const union ldlm_policy_data *,
 405                                             union ldlm_wire_policy_data *);
 406 void ldlm_plain_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 407                                      union ldlm_policy_data *lpolicy);
 408 void ldlm_plain_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 409                                      union ldlm_wire_policy_data *wpolicy);
 410 void ldlm_ibits_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 411                                      union ldlm_policy_data *lpolicy);
 412 void ldlm_ibits_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 413                                      union ldlm_wire_policy_data *wpolicy);
 414 void ldlm_extent_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 415                                       union ldlm_policy_data *lpolicy);
 416 void ldlm_extent_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 417                                       union ldlm_wire_policy_data *wpolicy);
 418 void ldlm_flock_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 419                                      union ldlm_policy_data *lpolicy);
 420 void ldlm_flock_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 421                                      union ldlm_wire_policy_data *wpolicy);
 422
 423 /* ldlm_reclaim.c */
 424 #ifdef HAVE_SERVER_SUPPORT
 425 extern __u64 ldlm_reclaim_threshold;
 426 extern __u64 ldlm_lock_limit;
 427 extern __u64 ldlm_reclaim_threshold_mb;
 428 extern __u64 ldlm_lock_limit_mb;
 429 extern struct percpu_counter ldlm_granted_total;
 430 #endif
 431 int ldlm_reclaim_setup(void);
 432 void ldlm_reclaim_cleanup(void);
 433 void ldlm_reclaim_add(struct ldlm_lock *lock);
 434 void ldlm_reclaim_del(struct ldlm_lock *lock);
 435 bool ldlm_reclaim_full(void);
 436
 437 static inline bool ldlm_res_eq(const struct ldlm_res_id *res0,
 438                                const struct ldlm_res_id *res1)
 439 {
 440         return memcmp(res0, res1, sizeof(*res0)) == 0;
 441 }