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