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