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