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         LDLM_CANCEL_LRUR_NO_WAIT = 1 << 5, /* LRUR + NO_WAIT */
 102 };
 103
 104 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr,
 105                     enum ldlm_cancel_flags sync, int flags);
 106 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
 107                          struct list_head *cancels, int count, int max,
 108                          enum ldlm_cancel_flags cancel_flags, int flags);
 109 extern int ldlm_enqueue_min;
 110
 111 /* ldlm_resource.c */
 112 int ldlm_resource_putref_locked(struct ldlm_resource *res);
 113 void ldlm_namespace_free_prior(struct ldlm_namespace *ns,
 114                                struct obd_import *imp, int force);
 115 void ldlm_namespace_free_post(struct ldlm_namespace *ns);
 116 /* ldlm_lock.c */
 117
 118 struct ldlm_cb_set_arg {
 119         struct ptlrpc_request_set       *set;
 120         int                              type; /* LDLM_{CP,BL,GL}_CALLBACK */
 121         atomic_t                         restart;
 122         struct list_head                        *list;
 123         union ldlm_gl_desc              *gl_desc; /* glimpse AST descriptor */
 124 };
 125
 126 enum ldlm_desc_ast_t {
 127         LDLM_WORK_BL_AST,
 128         LDLM_WORK_CP_AST,
 129         LDLM_WORK_REVOKE_AST,
 130         LDLM_WORK_GL_AST
 131 };
 132
 133 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
 134 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
 135                   enum req_location loc, void *data, int size);
 136 struct ldlm_lock *
 137 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
 138                  enum ldlm_type type, enum ldlm_mode mode,
 139                  const struct ldlm_callback_suite *cbs,
 140                  void *data, __u32 lvb_len, enum lvb_type lvb_type);
 141 enum ldlm_error ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
 142                                   void *cookie, __u64 *flags);
 143 void ldlm_lock_addref_internal(struct ldlm_lock *, __u32 mode);
 144 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, __u32 mode);
 145 void ldlm_lock_decref_internal(struct ldlm_lock *, __u32 mode);
 146 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, __u32 mode);
 147 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
 148                       enum ldlm_desc_ast_t ast_type);
 149 int ldlm_lock_remove_from_lru_check(struct ldlm_lock *lock, time_t last_use);
 150 #define ldlm_lock_remove_from_lru(lock) ldlm_lock_remove_from_lru_check(lock, 0)
 151 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
 152 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
 153
 154 /* ldlm_lockd.c */
 155 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
 156                            struct ldlm_lock *lock);
 157 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns,
 158                            struct ldlm_lock_desc *ld,
 159                            struct list_head *cancels, int count,
 160                            enum ldlm_cancel_flags cancel_flags);
 161
 162 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
 163                              struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
 164
 165 extern struct kmem_cache *ldlm_resource_slab;
 166 extern struct kset *ldlm_ns_kset;
 167
 168 /* ldlm_lockd.c & ldlm_lock.c */
 169 extern struct kmem_cache *ldlm_lock_slab;
 170
 171 /* ldlm_extent.c */
 172 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
 173 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
 174
 175 /* l_lock.c */
 176 void l_check_ns_lock(struct ldlm_namespace *ns);
 177 void l_check_no_ns_lock(struct ldlm_namespace *ns);
 178
 179 extern struct dentry *ldlm_svc_debugfs_dir;
 180
 181 struct ldlm_state {
 182         struct ptlrpc_service *ldlm_cb_service;
 183         struct ptlrpc_service *ldlm_cancel_service;
 184         struct ptlrpc_client *ldlm_client;
 185         struct ptlrpc_connection *ldlm_server_conn;
 186         struct ldlm_bl_pool *ldlm_bl_pool;
 187 };
 188
 189 /* ldlm_pool.c */
 190 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
 191 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
 192 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
 193
 194 /* interval tree, for LDLM_EXTENT. */
 195 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
 196 struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
 197 struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
 198 void ldlm_interval_free(struct ldlm_interval *node);
 199 /* this function must be called with res lock held */
 200 static inline struct ldlm_extent *
 201 ldlm_interval_extent(struct ldlm_interval *node)
 202 {
 203         struct ldlm_lock *lock;
 204
 205         LASSERT(!list_empty(&node->li_group));
 206
 207         lock = list_entry(node->li_group.next, struct ldlm_lock,
 208                               l_sl_policy);
 209         return &lock->l_policy_data.l_extent;
 210 }
 211
 212 int ldlm_init(void);
 213 void ldlm_exit(void);
 214
 215 enum ldlm_policy_res {
 216         LDLM_POLICY_CANCEL_LOCK,
 217         LDLM_POLICY_KEEP_LOCK,
 218         LDLM_POLICY_SKIP_LOCK
 219 };
 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              !ldlm_is_cp_reqd(lock))
 310                 ret = 1;
 311         else if (ldlm_is_failed(lock) || ldlm_is_cancel(lock))
 312                 ret = 1;
 313         unlock_res_and_lock(lock);
 314
 315         return ret;
 316 }
 317
 318 typedef void (*ldlm_policy_wire_to_local_t)(const ldlm_wire_policy_data_t *,
 319                                             ldlm_policy_data_t *);
 320
 321 typedef void (*ldlm_policy_local_to_wire_t)(const ldlm_policy_data_t *,
 322                                             ldlm_wire_policy_data_t *);
 323
 324 void ldlm_plain_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
 325                                      ldlm_policy_data_t *lpolicy);
 326 void ldlm_plain_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 327                                      ldlm_wire_policy_data_t *wpolicy);
 328 void ldlm_ibits_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
 329                                      ldlm_policy_data_t *lpolicy);
 330 void ldlm_ibits_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 331                                      ldlm_wire_policy_data_t *wpolicy);
 332 void ldlm_extent_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
 333                                      ldlm_policy_data_t *lpolicy);
 334 void ldlm_extent_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 335                                      ldlm_wire_policy_data_t *wpolicy);
 336 void ldlm_flock_policy_wire18_to_local(const ldlm_wire_policy_data_t *wpolicy,
 337                                      ldlm_policy_data_t *lpolicy);
 338 void ldlm_flock_policy_wire21_to_local(const ldlm_wire_policy_data_t *wpolicy,
 339                                      ldlm_policy_data_t *lpolicy);
 340
 341 void ldlm_flock_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 342                                      ldlm_wire_policy_data_t *wpolicy);