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 struct ldlm_cb_set_arg {
 128         struct ptlrpc_request_set       *set;
 129         int                              type; /* LDLM_{CP,BL,GL}_CALLBACK */
 130         atomic_t                         restart;
 131         struct list_head                        *list;
 132         union ldlm_gl_desc              *gl_desc; /* glimpse AST descriptor */
 133 };
 134
 135 typedef enum {
 136         LDLM_WORK_BL_AST,
 137         LDLM_WORK_CP_AST,
 138         LDLM_WORK_REVOKE_AST,
 139         LDLM_WORK_GL_AST
 140 } ldlm_desc_ast_t;
 141
 142 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
 143 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
 144                   enum req_location loc, void *data, int size);
 145 struct ldlm_lock *
 146 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
 147                  enum ldlm_type type, enum ldlm_mode mode,
 148                  const struct ldlm_callback_suite *cbs,
 149                  void *data, __u32 lvb_len, enum lvb_type lvb_type);
 150 enum ldlm_error ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
 151                                   void *cookie, __u64 *flags);
 152 void ldlm_lock_addref_internal(struct ldlm_lock *, enum ldlm_mode mode);
 153 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
 154 void ldlm_lock_decref_internal(struct ldlm_lock *, enum ldlm_mode mode);
 155 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
 156 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
 157                             struct list_head *work_list);
 158 #ifdef HAVE_SERVER_SUPPORT
 159 int ldlm_reprocess_queue(struct ldlm_resource *res, struct list_head *queue,
 160                          struct list_head *work_list);
 161 #endif
 162 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
 163                       ldlm_desc_ast_t ast_type);
 164 int ldlm_work_gl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq);
 165 int ldlm_lock_remove_from_lru_check(struct ldlm_lock *lock,
 166                                     cfs_time_t last_use);
 167 #define ldlm_lock_remove_from_lru(lock) ldlm_lock_remove_from_lru_check(lock, 0)
 168 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
 169 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
 170 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
 171 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
 172 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
 173
 174 int ldlm_export_cancel_blocked_locks(struct obd_export *exp);
 175 int ldlm_export_cancel_locks(struct obd_export *exp);
 176
 177 /* ldlm_lockd.c */
 178 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
 179                            struct ldlm_lock *lock);
 180 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns,
 181                            struct ldlm_lock_desc *ld,
 182                            struct list_head *cancels, int count,
 183                            enum ldlm_cancel_flags cancel_flags);
 184 int ldlm_bl_thread_wakeup(void);
 185
 186 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
 187                              struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
 188
 189 #ifdef HAVE_SERVER_SUPPORT
 190 /* ldlm_plain.c */
 191 int ldlm_process_plain_lock(struct ldlm_lock *lock, __u64 *flags,
 192                             int first_enq, enum ldlm_error *err,
 193                             struct list_head *work_list);
 194
 195 /* ldlm_inodebits.c */
 196 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
 197                                 int first_enq, enum ldlm_error *err,
 198                                 struct list_head *work_list);
 199 #endif
 200
 201 /* ldlm_extent.c */
 202 #ifdef HAVE_SERVER_SUPPORT
 203 int ldlm_process_extent_lock(struct ldlm_lock *lock, __u64 *flags,
 204                              int first_enq, enum ldlm_error *err,
 205                              struct list_head *work_list);
 206 #endif
 207 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
 208 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
 209
 210 /* ldlm_flock.c */
 211 int ldlm_process_flock_lock(struct ldlm_lock *req, __u64 *flags,
 212                             int first_enq, enum ldlm_error *err,
 213                             struct list_head *work_list);
 214 int ldlm_init_flock_export(struct obd_export *exp);
 215 void ldlm_destroy_flock_export(struct obd_export *exp);
 216
 217 /* l_lock.c */
 218 void l_check_ns_lock(struct ldlm_namespace *ns);
 219 void l_check_no_ns_lock(struct ldlm_namespace *ns);
 220
 221 extern struct proc_dir_entry *ldlm_svc_proc_dir;
 222
 223 struct ldlm_state {
 224         struct ptlrpc_service *ldlm_cb_service;
 225         struct ptlrpc_service *ldlm_cancel_service;
 226         struct ptlrpc_client *ldlm_client;
 227         struct ptlrpc_connection *ldlm_server_conn;
 228         struct ldlm_bl_pool *ldlm_bl_pool;
 229 };
 230
 231 /* interval tree, for LDLM_EXTENT. */
 232 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
 233 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
 234 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
 235 extern struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
 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                                    unsigned long 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                                    unsigned long 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 lprocfs_vars *vars, struct proc_dir_entry *proc_dir,
 342              const char *name, void *data, const struct file_operations *ops)
 343 {
 344         snprintf((char *)vars->name, MAX_STRING_SIZE, "%s", name);
 345         vars->data = data;
 346         vars->fops = ops;
 347         lprocfs_add_vars(proc_dir, 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         if ((lock->l_req_mode == lock->l_granted_mode) &&
 356              !ldlm_is_cp_reqd(lock))
 357                 ret = 1;
 358         else if (ldlm_is_failed(lock) || ldlm_is_cancel(lock))
 359                 ret = 1;
 360         unlock_res_and_lock(lock);
 361
 362         return ret;
 363 }
 364
 365 typedef void (*ldlm_policy_wire_to_local_t)(const union ldlm_wire_policy_data *,
 366                                             union ldlm_policy_data *);
 367 typedef void (*ldlm_policy_local_to_wire_t)(const union ldlm_policy_data *,
 368                                             union ldlm_wire_policy_data *);
 369 void ldlm_plain_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 370                                      union ldlm_policy_data *lpolicy);
 371 void ldlm_plain_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 372                                      union ldlm_wire_policy_data *wpolicy);
 373 void ldlm_ibits_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 374                                      union ldlm_policy_data *lpolicy);
 375 void ldlm_ibits_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 376                                      union ldlm_wire_policy_data *wpolicy);
 377 void ldlm_extent_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 378                                       union ldlm_policy_data *lpolicy);
 379 void ldlm_extent_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 380                                       union ldlm_wire_policy_data *wpolicy);
 381 void ldlm_flock_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 382                                      union ldlm_policy_data *lpolicy);
 383 void ldlm_flock_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 384                                      union ldlm_wire_policy_data *wpolicy);
 385
 386 /* ldlm_reclaim.c */
 387 #ifdef HAVE_SERVER_SUPPORT
 388 extern __u64 ldlm_reclaim_threshold;
 389 extern __u64 ldlm_lock_limit;
 390 extern __u64 ldlm_reclaim_threshold_mb;
 391 extern __u64 ldlm_lock_limit_mb;
 392 extern struct percpu_counter ldlm_granted_total;
 393 #endif
 394 int ldlm_reclaim_setup(void);
 395 void ldlm_reclaim_cleanup(void);
 396 void ldlm_reclaim_add(struct ldlm_lock *lock);
 397 void ldlm_reclaim_del(struct ldlm_lock *lock);
 398 bool ldlm_reclaim_full(void);
 399
 400 static inline bool ldlm_res_eq(const struct ldlm_res_id *res0,
 401                                const struct ldlm_res_id *res1)
 402 {
 403         return memcmp(res0, res1, sizeof(*res0)) == 0;
 404 }