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