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_NO_WAIT   = 0x1, /* Cancel locks w/o blocking (neither
 102                                         * sending nor waiting for any RPCs) */
 103         LDLM_LRU_FLAG_CLEANUP   = 0x2, /* Used when clearing lru, tells
 104                                         * prepare_lru_list to set discard flag
 105                                         * on PR extent locks so we don't waste
 106                                         * time saving pages that will be
 107                                         * discarded momentarily */
 108 };
 109
 110 int ldlm_cancel_lru(struct ldlm_namespace *ns, int min,
 111                     enum ldlm_cancel_flags cancel_flags,
 112                     enum ldlm_lru_flags lru_flags);
 113 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
 114                           struct list_head *cancels, int min, int max,
 115                           enum ldlm_cancel_flags cancel_flags,
 116                           enum ldlm_lru_flags lru_flags);
 117 extern unsigned int ldlm_enqueue_min;
 118 /* ldlm_resource.c */
 119 extern struct kmem_cache *ldlm_resource_slab;
 120 extern struct kmem_cache *ldlm_lock_slab;
 121 extern struct kmem_cache *ldlm_inodebits_slab;
 122 extern struct kmem_cache *ldlm_interval_tree_slab;
 123
 124 void ldlm_resource_insert_lock_after(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 ptlrpc_connection *ldlm_server_conn;
 243         struct ldlm_bl_pool *ldlm_bl_pool;
 244 };
 245
 246 /* interval tree, for LDLM_EXTENT. */
 247 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
 248 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
 249 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
 250 extern void ldlm_interval_free(struct ldlm_interval *node);
 251 /* this function must be called with res lock held */
 252 static inline struct ldlm_extent *
 253 ldlm_interval_extent(struct ldlm_interval *node)
 254 {
 255         struct ldlm_lock *lock;
 256         LASSERT(!list_empty(&node->li_group));
 257
 258         lock = list_entry(node->li_group.next, struct ldlm_lock,
 259                               l_sl_policy);
 260         return &lock->l_policy_data.l_extent;
 261 }
 262
 263 int ldlm_init(void);
 264 void ldlm_exit(void);
 265
 266 enum ldlm_policy_res {
 267         LDLM_POLICY_CANCEL_LOCK,
 268         LDLM_POLICY_KEEP_LOCK,
 269         LDLM_POLICY_SKIP_LOCK
 270 };
 271
 272 #define LDLM_POOL_SYSFS_PRINT_int(v) sprintf(buf, "%d\n", v)
 273 #define LDLM_POOL_SYSFS_SET_int(a, b) { a = b; }
 274 #define LDLM_POOL_SYSFS_PRINT_u64(v) sprintf(buf, "%lld\n", v)
 275 #define LDLM_POOL_SYSFS_SET_u64(a, b) { a = b; }
 276 #define LDLM_POOL_SYSFS_PRINT_atomic(v) sprintf(buf, "%d\n", atomic_read(&v))
 277 #define LDLM_POOL_SYSFS_SET_atomic(a, b) atomic_set(&a, b)
 278
 279 #define LDLM_POOL_SYSFS_READER_SHOW(var, type)                             \
 280         static ssize_t var##_show(struct kobject *kobj,                    \
 281                                   struct attribute *attr,                  \
 282                                   char *buf)                               \
 283         {                                                                  \
 284                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
 285                                                     pl_kobj);              \
 286                 type tmp;                                                  \
 287                                                                            \
 288                 spin_lock(&pl->pl_lock);                                   \
 289                 tmp = pl->pl_##var;                                        \
 290                 spin_unlock(&pl->pl_lock);                                 \
 291                                                                            \
 292                 return LDLM_POOL_SYSFS_PRINT_##type(tmp);                  \
 293         }                                                                  \
 294         struct __##var##__dummy_read {;} /* semicolon catcher */
 295
 296 #define LDLM_POOL_SYSFS_WRITER_STORE(var, type)                            \
 297         static ssize_t var##_store(struct kobject *kobj,                   \
 298                                    struct attribute *attr,                 \
 299                                    const char *buffer,                     \
 300                                    size_t count)                           \
 301         {                                                                  \
 302                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
 303                                                     pl_kobj);              \
 304                 unsigned long tmp;                                         \
 305                 int rc;                                                    \
 306                                                                            \
 307                 rc = kstrtoul(buffer, 10, &tmp);                           \
 308                 if (rc < 0) {                                              \
 309                         return rc;                                         \
 310                 }                                                          \
 311                                                                            \
 312                 spin_lock(&pl->pl_lock);                                   \
 313                 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp);             \
 314                 spin_unlock(&pl->pl_lock);                                 \
 315                                                                            \
 316                 return count;                                              \
 317         }                                                                  \
 318         struct __##var##__dummy_write {; } /* semicolon catcher */
 319
 320 #define LDLM_POOL_SYSFS_READER_NOLOCK_SHOW(var, type)                      \
 321         static ssize_t var##_show(struct kobject *kobj,                    \
 322                                   struct attribute *attr,                  \
 323                                   char *buf)                               \
 324         {                                                                  \
 325                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
 326                                                     pl_kobj);              \
 327                                                                            \
 328                 return LDLM_POOL_SYSFS_PRINT_##type(pl->pl_##var);         \
 329         }                                                                  \
 330         struct __##var##__dummy_read {; } /* semicolon catcher */
 331
 332 #define LDLM_POOL_SYSFS_WRITER_NOLOCK_STORE(var, type)                     \
 333         static ssize_t var##_store(struct kobject *kobj,                   \
 334                                    struct attribute *attr,                 \
 335                                    const char *buffer,                     \
 336                                    size_t count)                           \
 337         {                                                                  \
 338                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
 339                                                     pl_kobj);              \
 340                 unsigned long tmp;                                         \
 341                 int rc;                                                    \
 342                                                                            \
 343                 rc = kstrtoul(buffer, 10, &tmp);                           \
 344                 if (rc < 0) {                                              \
 345                         return rc;                                         \
 346                 }                                                          \
 347                                                                            \
 348                 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp);             \
 349                                                                            \
 350                 return count;                                              \
 351         }                                                                  \
 352         struct __##var##__dummy_write {; } /* semicolon catcher */
 353
 354 static inline void
 355 ldlm_add_var(struct lprocfs_vars *vars, struct dentry *debugfs_entry,
 356              const char *name, void *data, const struct file_operations *ops)
 357 {
 358         snprintf((char *)vars->name, MAX_STRING_SIZE, "%s", name);
 359         vars->data = data;
 360         vars->fops = ops;
 361         ldebugfs_add_vars(debugfs_entry, vars, NULL);
 362 }
 363
 364 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
 365 {
 366         int ret = 0;
 367
 368         lock_res_and_lock(lock);
 369         ret = is_granted_or_cancelled_nolock(lock);
 370         unlock_res_and_lock(lock);
 371
 372         return ret;
 373 }
 374
 375 static inline bool is_bl_done(struct ldlm_lock *lock)
 376 {
 377         bool bl_done = true;
 378
 379         if (!ldlm_is_bl_done(lock)) {
 380                 lock_res_and_lock(lock);
 381                 bl_done = ldlm_is_bl_done(lock);
 382                 unlock_res_and_lock(lock);
 383         }
 384
 385         return bl_done;
 386 }
 387
 388 static inline bool is_lock_converted(struct ldlm_lock *lock)
 389 {
 390         bool ret = 0;
 391
 392         lock_res_and_lock(lock);
 393         ret = (lock->l_policy_data.l_inodebits.cancel_bits == 0);
 394         unlock_res_and_lock(lock);
 395
 396         return ret;
 397 }
 398
 399 typedef void (*ldlm_policy_wire_to_local_t)(const union ldlm_wire_policy_data *,
 400                                             union ldlm_policy_data *);
 401 typedef void (*ldlm_policy_local_to_wire_t)(const union ldlm_policy_data *,
 402                                             union ldlm_wire_policy_data *);
 403 void ldlm_plain_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 404                                      union ldlm_policy_data *lpolicy);
 405 void ldlm_plain_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 406                                      union ldlm_wire_policy_data *wpolicy);
 407 void ldlm_ibits_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 408                                      union ldlm_policy_data *lpolicy);
 409 void ldlm_ibits_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 410                                      union ldlm_wire_policy_data *wpolicy);
 411 void ldlm_extent_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 412                                       union ldlm_policy_data *lpolicy);
 413 void ldlm_extent_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 414                                       union ldlm_wire_policy_data *wpolicy);
 415 void ldlm_flock_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 416                                      union ldlm_policy_data *lpolicy);
 417 void ldlm_flock_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 418                                      union ldlm_wire_policy_data *wpolicy);
 419
 420 /* ldlm_reclaim.c */
 421 #ifdef HAVE_SERVER_SUPPORT
 422 extern __u64 ldlm_reclaim_threshold;
 423 extern __u64 ldlm_lock_limit;
 424 extern __u64 ldlm_reclaim_threshold_mb;
 425 extern __u64 ldlm_lock_limit_mb;
 426 extern struct percpu_counter ldlm_granted_total;
 427 #endif
 428 int ldlm_reclaim_setup(void);
 429 void ldlm_reclaim_cleanup(void);
 430 void ldlm_reclaim_add(struct ldlm_lock *lock);
 431 void ldlm_reclaim_del(struct ldlm_lock *lock);
 432 bool ldlm_reclaim_full(void);
 433
 434 static inline bool ldlm_res_eq(const struct ldlm_res_id *res0,
 435                                const struct ldlm_res_id *res1)
 436 {
 437         return memcmp(res0, res1, sizeof(*res0)) == 0;
 438 }