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