drivers/staging/lustre/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.sun.com/software/products/lustre/docs/GPLv2.pdf
  19  *
  20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  21  * CA 95054 USA or visit www.sun.com if you need additional information or
  22  * have any questions.
  23  *
  24  * GPL HEADER END
  25  */
  26 /*
  27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  28  * Use is subject to license terms.
  29  *
  30  * Copyright (c) 2011, 2015, Intel Corporation.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36
  37 #define MAX_STRING_SIZE 128
  38
  39 extern int ldlm_srv_namespace_nr;
  40 extern int ldlm_cli_namespace_nr;
  41 extern struct mutex ldlm_srv_namespace_lock;
  42 extern struct list_head ldlm_srv_namespace_list;
  43 extern struct mutex ldlm_cli_namespace_lock;
  44 extern struct list_head ldlm_cli_active_namespace_list;
  45
  46 static inline int ldlm_namespace_nr_read(ldlm_side_t client)
  47 {
  48         return client == LDLM_NAMESPACE_SERVER ?
  49                 ldlm_srv_namespace_nr : ldlm_cli_namespace_nr;
  50 }
  51
  52 static inline void ldlm_namespace_nr_inc(ldlm_side_t client)
  53 {
  54         if (client == LDLM_NAMESPACE_SERVER)
  55                 ldlm_srv_namespace_nr++;
  56         else
  57                 ldlm_cli_namespace_nr++;
  58 }
  59
  60 static inline void ldlm_namespace_nr_dec(ldlm_side_t client)
  61 {
  62         if (client == LDLM_NAMESPACE_SERVER)
  63                 ldlm_srv_namespace_nr--;
  64         else
  65                 ldlm_cli_namespace_nr--;
  66 }
  67
  68 static inline struct list_head *ldlm_namespace_list(ldlm_side_t client)
  69 {
  70         return client == LDLM_NAMESPACE_SERVER ?
  71                 &ldlm_srv_namespace_list : &ldlm_cli_active_namespace_list;
  72 }
  73
  74 static inline struct mutex *ldlm_namespace_lock(ldlm_side_t client)
  75 {
  76         return client == LDLM_NAMESPACE_SERVER ?
  77                 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
  78 }
  79
  80 /* ns_bref is the number of resources in this namespace */
  81 static inline int ldlm_ns_empty(struct ldlm_namespace *ns)
  82 {
  83         return atomic_read(&ns->ns_bref) == 0;
  84 }
  85
  86 void ldlm_namespace_move_to_active_locked(struct ldlm_namespace *, ldlm_side_t);
  87 void ldlm_namespace_move_to_inactive_locked(struct ldlm_namespace *,
  88                                             ldlm_side_t);
  89 struct ldlm_namespace *ldlm_namespace_first_locked(ldlm_side_t);
  90
  91 /* ldlm_request.c */
  92 /* Cancel lru flag, it indicates we cancel aged locks. */
  93 enum {
  94         LDLM_CANCEL_AGED   = 1 << 0, /* Cancel aged locks (non lru resize). */
  95         LDLM_CANCEL_PASSED = 1 << 1, /* Cancel passed number of locks. */
  96         LDLM_CANCEL_SHRINK = 1 << 2, /* Cancel locks from shrinker. */
  97         LDLM_CANCEL_LRUR   = 1 << 3, /* Cancel locks from lru resize. */
  98         LDLM_CANCEL_NO_WAIT = 1 << 4 /* Cancel locks w/o blocking (neither
  99                                       * sending nor waiting for any rpcs)
 100                                       */
 101 };
 102
 103 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr,
 104                     enum ldlm_cancel_flags sync, int flags);
 105 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
 106                          struct list_head *cancels, int count, int max,
 107                          enum ldlm_cancel_flags cancel_flags, int flags);
 108 extern int ldlm_enqueue_min;
 109
 110 /* ldlm_resource.c */
 111 int ldlm_resource_putref_locked(struct ldlm_resource *res);
 112 void ldlm_namespace_free_prior(struct ldlm_namespace *ns,
 113                                struct obd_import *imp, int force);
 114 void ldlm_namespace_free_post(struct ldlm_namespace *ns);
 115 /* ldlm_lock.c */
 116
 117 struct ldlm_cb_set_arg {
 118         struct ptlrpc_request_set       *set;
 119         int                              type; /* LDLM_{CP,BL,GL}_CALLBACK */
 120         atomic_t                         restart;
 121         struct list_head                        *list;
 122         union ldlm_gl_desc              *gl_desc; /* glimpse AST descriptor */
 123 };
 124
 125 enum ldlm_desc_ast_t {
 126         LDLM_WORK_BL_AST,
 127         LDLM_WORK_CP_AST,
 128         LDLM_WORK_REVOKE_AST,
 129         LDLM_WORK_GL_AST
 130 };
 131
 132 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
 133 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
 134                   enum req_location loc, void *data, int size);
 135 struct ldlm_lock *
 136 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
 137                  enum ldlm_type type, enum ldlm_mode mode,
 138                  const struct ldlm_callback_suite *cbs,
 139                  void *data, __u32 lvb_len, enum lvb_type lvb_type);
 140 enum ldlm_error ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
 141                                   void *cookie, __u64 *flags);
 142 void ldlm_lock_addref_internal(struct ldlm_lock *, __u32 mode);
 143 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, __u32 mode);
 144 void ldlm_lock_decref_internal(struct ldlm_lock *, __u32 mode);
 145 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, __u32 mode);
 146 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
 147                       enum ldlm_desc_ast_t ast_type);
 148 int ldlm_lock_remove_from_lru(struct ldlm_lock *lock);
 149 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
 150 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
 151
 152 /* ldlm_lockd.c */
 153 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
 154                            struct ldlm_lock *lock);
 155 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns,
 156                            struct ldlm_lock_desc *ld,
 157                            struct list_head *cancels, int count,
 158                            enum ldlm_cancel_flags cancel_flags);
 159
 160 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
 161                              struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
 162
 163 extern struct kmem_cache *ldlm_resource_slab;
 164 extern struct kset *ldlm_ns_kset;
 165
 166 /* ldlm_lockd.c & ldlm_lock.c */
 167 extern struct kmem_cache *ldlm_lock_slab;
 168
 169 /* ldlm_extent.c */
 170 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
 171 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
 172
 173 /* l_lock.c */
 174 void l_check_ns_lock(struct ldlm_namespace *ns);
 175 void l_check_no_ns_lock(struct ldlm_namespace *ns);
 176
 177 extern struct dentry *ldlm_svc_debugfs_dir;
 178
 179 struct ldlm_state {
 180         struct ptlrpc_service *ldlm_cb_service;
 181         struct ptlrpc_service *ldlm_cancel_service;
 182         struct ptlrpc_client *ldlm_client;
 183         struct ptlrpc_connection *ldlm_server_conn;
 184         struct ldlm_bl_pool *ldlm_bl_pool;
 185 };
 186
 187 /* ldlm_pool.c */
 188 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
 189 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
 190 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
 191
 192 /* interval tree, for LDLM_EXTENT. */
 193 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
 194 struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
 195 struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
 196 void ldlm_interval_free(struct ldlm_interval *node);
 197 /* this function must be called with res lock held */
 198 static inline struct ldlm_extent *
 199 ldlm_interval_extent(struct ldlm_interval *node)
 200 {
 201         struct ldlm_lock *lock;
 202
 203         LASSERT(!list_empty(&node->li_group));
 204
 205         lock = list_entry(node->li_group.next, struct ldlm_lock,
 206                               l_sl_policy);
 207         return &lock->l_policy_data.l_extent;
 208 }
 209
 210 int ldlm_init(void);
 211 void ldlm_exit(void);
 212
 213 enum ldlm_policy_res {
 214         LDLM_POLICY_CANCEL_LOCK,
 215         LDLM_POLICY_KEEP_LOCK,
 216         LDLM_POLICY_SKIP_LOCK
 217 };
 218
 219 typedef enum ldlm_policy_res ldlm_policy_res_t;
 220
 221 #define LDLM_POOL_SYSFS_PRINT_int(v) sprintf(buf, "%d\n", v)
 222 #define LDLM_POOL_SYSFS_SET_int(a, b) { a = b; }
 223 #define LDLM_POOL_SYSFS_PRINT_u64(v) sprintf(buf, "%lld\n", v)
 224 #define LDLM_POOL_SYSFS_SET_u64(a, b) { a = b; }
 225 #define LDLM_POOL_SYSFS_PRINT_atomic(v) sprintf(buf, "%d\n", atomic_read(&v))
 226 #define LDLM_POOL_SYSFS_SET_atomic(a, b) atomic_set(&a, b)
 227
 228 #define LDLM_POOL_SYSFS_READER_SHOW(var, type)                              \
 229         static ssize_t var##_show(struct kobject *kobj,                     \
 230                                   struct attribute *attr,                   \
 231                                   char *buf)                                \
 232         {                                                                   \
 233                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool, \
 234                                                     pl_kobj);               \
 235                 type tmp;                                                   \
 236                                                                             \
 237                 spin_lock(&pl->pl_lock);                                    \
 238                 tmp = pl->pl_##var;                                         \
 239                 spin_unlock(&pl->pl_lock);                                  \
 240                                                                             \
 241                 return LDLM_POOL_SYSFS_PRINT_##type(tmp);                   \
 242         }                                                                   \
 243         struct __##var##__dummy_read {; } /* semicolon catcher */
 244
 245 #define LDLM_POOL_SYSFS_WRITER_STORE(var, type)                             \
 246         static ssize_t var##_store(struct kobject *kobj,                    \
 247                                      struct attribute *attr,                \
 248                                      const char *buffer,                    \
 249                                      size_t count)                          \
 250         {                                                                   \
 251                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool, \
 252                                                     pl_kobj);               \
 253                 unsigned long tmp;                                          \
 254                 int rc;                                                     \
 255                                                                             \
 256                 rc = kstrtoul(buffer, 10, &tmp);                            \
 257                 if (rc < 0) {                                               \
 258                         return rc;                                          \
 259                 }                                                           \
 260                                                                             \
 261                 spin_lock(&pl->pl_lock);                                    \
 262                 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp);              \
 263                 spin_unlock(&pl->pl_lock);                                  \
 264                                                                             \
 265                 return count;                                               \
 266         }                                                                   \
 267         struct __##var##__dummy_write {; } /* semicolon catcher */
 268
 269 #define LDLM_POOL_SYSFS_READER_NOLOCK_SHOW(var, type)                       \
 270         static ssize_t var##_show(struct kobject *kobj,             \
 271                                     struct attribute *attr,                 \
 272                                     char *buf)                              \
 273         {                                                                   \
 274                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool, \
 275                                                     pl_kobj);               \
 276                                                                             \
 277                 return LDLM_POOL_SYSFS_PRINT_##type(pl->pl_##var);          \
 278         }                                                                   \
 279         struct __##var##__dummy_read {; } /* semicolon catcher */
 280
 281 #define LDLM_POOL_SYSFS_WRITER_NOLOCK_STORE(var, type)                      \
 282         static ssize_t var##_store(struct kobject *kobj,                    \
 283                                      struct attribute *attr,                \
 284                                      const char *buffer,                    \
 285                                      size_t count)                          \
 286         {                                                                   \
 287                 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool, \
 288                                                     pl_kobj);               \
 289                 unsigned long tmp;                                          \
 290                 int rc;                                                     \
 291                                                                             \
 292                 rc = kstrtoul(buffer, 10, &tmp);                            \
 293                 if (rc < 0) {                                               \
 294                         return rc;                                          \
 295                 }                                                           \
 296                                                                             \
 297                 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp);              \
 298                                                                             \
 299                 return count;                                               \
 300         }                                                                   \
 301         struct __##var##__dummy_write {; } /* semicolon catcher */
 302
 303 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
 304 {
 305         int ret = 0;
 306
 307         lock_res_and_lock(lock);
 308         if (((lock->l_req_mode == lock->l_granted_mode) &&
 309              !(lock->l_flags & LDLM_FL_CP_REQD)) ||
 310             (lock->l_flags & (LDLM_FL_FAILED | LDLM_FL_CANCEL)))
 311                 ret = 1;
 312         unlock_res_and_lock(lock);
 313
 314         return ret;
 315 }
 316
 317 typedef void (*ldlm_policy_wire_to_local_t)(const ldlm_wire_policy_data_t *,
 318                                             ldlm_policy_data_t *);
 319
 320 typedef void (*ldlm_policy_local_to_wire_t)(const ldlm_policy_data_t *,
 321                                             ldlm_wire_policy_data_t *);
 322
 323 void ldlm_plain_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
 324                                      ldlm_policy_data_t *lpolicy);
 325 void ldlm_plain_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 326                                      ldlm_wire_policy_data_t *wpolicy);
 327 void ldlm_ibits_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
 328                                      ldlm_policy_data_t *lpolicy);
 329 void ldlm_ibits_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 330                                      ldlm_wire_policy_data_t *wpolicy);
 331 void ldlm_extent_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
 332                                      ldlm_policy_data_t *lpolicy);
 333 void ldlm_extent_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 334                                      ldlm_wire_policy_data_t *wpolicy);
 335 void ldlm_flock_policy_wire18_to_local(const ldlm_wire_policy_data_t *wpolicy,
 336                                      ldlm_policy_data_t *lpolicy);
 337 void ldlm_flock_policy_wire21_to_local(const ldlm_wire_policy_data_t *wpolicy,
 338                                      ldlm_policy_data_t *lpolicy);
 339
 340 void ldlm_flock_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 341                                      ldlm_wire_policy_data_t *wpolicy);