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, 2013, 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 extern struct list_head ldlm_cli_inactive_namespace_list;
  46 extern unsigned int ldlm_cancel_unused_locks_before_replay;
  47
  48 static inline int ldlm_namespace_nr_read(enum ldlm_side client)
  49 {
  50         return client == LDLM_NAMESPACE_SERVER ?
  51                 ldlm_srv_namespace_nr : ldlm_cli_namespace_nr;
  52 }
  53
  54 static inline void ldlm_namespace_nr_inc(enum ldlm_side client)
  55 {
  56         if (client == LDLM_NAMESPACE_SERVER)
  57                 ldlm_srv_namespace_nr++;
  58         else
  59                 ldlm_cli_namespace_nr++;
  60 }
  61
  62 static inline void ldlm_namespace_nr_dec(enum ldlm_side client)
  63 {
  64         if (client == LDLM_NAMESPACE_SERVER)
  65                 ldlm_srv_namespace_nr--;
  66         else
  67                 ldlm_cli_namespace_nr--;
  68 }
  69
  70 static inline struct list_head *ldlm_namespace_list(enum ldlm_side client)
  71 {
  72         return client == LDLM_NAMESPACE_SERVER ?
  73                 &ldlm_srv_namespace_list : &ldlm_cli_active_namespace_list;
  74 }
  75
  76 static inline
  77 struct list_head *ldlm_namespace_inactive_list(enum ldlm_side client)
  78 {
  79         return client == LDLM_NAMESPACE_SERVER ?
  80                 &ldlm_srv_namespace_list : &ldlm_cli_inactive_namespace_list;
  81 }
  82
  83 static inline struct mutex *ldlm_namespace_lock(enum ldlm_side client)
  84 {
  85         return client == LDLM_NAMESPACE_SERVER ?
  86                 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
  87 }
  88
  89 /* ns_bref is the number of resources in this namespace */
  90 static inline int ldlm_ns_empty(struct ldlm_namespace *ns)
  91 {
  92         return atomic_read(&ns->ns_bref) == 0;
  93 }
  94
  95 void ldlm_namespace_move_to_active_locked(struct ldlm_namespace *,
  96                                           enum ldlm_side);
  97 void ldlm_namespace_move_to_inactive_locked(struct ldlm_namespace *,
  98                                             enum ldlm_side);
  99 struct ldlm_namespace *ldlm_namespace_first_locked(enum ldlm_side);
 100
 101 /* ldlm_request.c */
 102 /* Cancel lru flag, it indicates we cancel aged locks. */
 103 enum ldlm_lru_flags {
 104         LDLM_LRU_FLAG_AGED      = 0x01, /* Cancel aged locks (non LRU resize) */
 105         LDLM_LRU_FLAG_PASSED    = 0x02, /* Cancel passed number of locks */
 106         LDLM_LRU_FLAG_SHRINK    = 0x04, /* Cancel locks from shrinker */
 107         LDLM_LRU_FLAG_LRUR      = 0x08, /* Cancel locks from lru resize */
 108         LDLM_LRU_FLAG_NO_WAIT   = 0x10, /* Cancel locks w/o blocking (neither
 109                                          * sending nor waiting for any RPCs) */
 110         LDLM_LRU_FLAG_LRUR_NO_WAIT = 0x20, /* LRUR + NO_WAIT */
 111 };
 112
 113 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr,
 114                     enum ldlm_cancel_flags cancel_flags,
 115                     enum ldlm_lru_flags lru_flags);
 116 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
 117                           struct list_head *cancels, int count, int max,
 118                           enum ldlm_cancel_flags cancel_flags,
 119                           enum ldlm_lru_flags lru_flags);
 120 extern unsigned int ldlm_enqueue_min;
 121 /* ldlm_resource.c */
 122 extern struct kmem_cache *ldlm_resource_slab;
 123 extern struct kmem_cache *ldlm_lock_slab;
 124 extern struct kmem_cache *ldlm_interval_tree_slab;
 125
 126 int ldlm_resource_putref_locked(struct ldlm_resource *res);
 127 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
 128                                      struct ldlm_lock *new);
 129
 130 /* ldlm_lock.c */
 131
 132 struct ldlm_cb_set_arg {
 133         struct ptlrpc_request_set       *set;
 134         int                              type; /* LDLM_{CP,BL,GL}_CALLBACK */
 135         atomic_t                         restart;
 136         struct list_head                        *list;
 137         union ldlm_gl_desc              *gl_desc; /* glimpse AST descriptor */
 138 };
 139
 140 typedef enum {
 141         LDLM_WORK_BL_AST,
 142         LDLM_WORK_CP_AST,
 143         LDLM_WORK_REVOKE_AST,
 144         LDLM_WORK_GL_AST
 145 } ldlm_desc_ast_t;
 146
 147 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
 148 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
 149                   enum req_location loc, void *data, int size);
 150 struct ldlm_lock *
 151 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
 152                  enum ldlm_type type, enum ldlm_mode mode,
 153                  const struct ldlm_callback_suite *cbs,
 154                  void *data, __u32 lvb_len, enum lvb_type lvb_type);
 155 enum ldlm_error ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
 156                                   void *cookie, __u64 *flags);
 157 void ldlm_lock_addref_internal(struct ldlm_lock *, enum ldlm_mode mode);
 158 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
 159 void ldlm_lock_decref_internal(struct ldlm_lock *, enum ldlm_mode mode);
 160 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
 161 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
 162                             struct list_head *work_list);
 163 #ifdef HAVE_SERVER_SUPPORT
 164 int ldlm_reprocess_queue(struct ldlm_resource *res, struct list_head *queue,
 165                          struct list_head *work_list);
 166 #endif
 167 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
 168                       ldlm_desc_ast_t ast_type);
 169 int ldlm_work_gl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq);
 170 int ldlm_lock_remove_from_lru_check(struct ldlm_lock *lock,
 171                                     cfs_time_t last_use);
 172 #define ldlm_lock_remove_from_lru(lock) ldlm_lock_remove_from_lru_check(lock, 0)
 173 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
 174 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
 175 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
 176 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
 177 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
 178
 179 int ldlm_export_cancel_blocked_locks(struct obd_export *exp);
 180 int ldlm_export_cancel_locks(struct obd_export *exp);
 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
 194 #ifdef HAVE_SERVER_SUPPORT
 195 /* ldlm_plain.c */
 196 int ldlm_process_plain_lock(struct ldlm_lock *lock, __u64 *flags,
 197                             int first_enq, enum ldlm_error *err,
 198                             struct list_head *work_list);
 199
 200 /* ldlm_inodebits.c */
 201 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
 202                                 int first_enq, enum ldlm_error *err,
 203                                 struct list_head *work_list);
 204 #endif
 205
 206 /* ldlm_extent.c */
 207 #ifdef HAVE_SERVER_SUPPORT
 208 int ldlm_process_extent_lock(struct ldlm_lock *lock, __u64 *flags,
 209                              int first_enq, enum ldlm_error *err,
 210                              struct list_head *work_list);
 211 #endif
 212 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
 213 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
 214
 215 /* ldlm_flock.c */
 216 int ldlm_process_flock_lock(struct ldlm_lock *req, __u64 *flags,
 217                             int first_enq, enum ldlm_error *err,
 218                             struct list_head *work_list);
 219 int ldlm_init_flock_export(struct obd_export *exp);
 220 void ldlm_destroy_flock_export(struct obd_export *exp);
 221
 222 /* l_lock.c */
 223 void l_check_ns_lock(struct ldlm_namespace *ns);
 224 void l_check_no_ns_lock(struct ldlm_namespace *ns);
 225
 226 extern struct proc_dir_entry *ldlm_svc_proc_dir;
 227
 228 struct ldlm_state {
 229         struct ptlrpc_service *ldlm_cb_service;
 230         struct ptlrpc_service *ldlm_cancel_service;
 231         struct ptlrpc_client *ldlm_client;
 232         struct ptlrpc_connection *ldlm_server_conn;
 233         struct ldlm_bl_pool *ldlm_bl_pool;
 234 };
 235
 236 /* interval tree, for LDLM_EXTENT. */
 237 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
 238 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
 239 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
 240 extern struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
 241 extern void ldlm_interval_free(struct ldlm_interval *node);
 242 /* this function must be called with res lock held */
 243 static inline struct ldlm_extent *
 244 ldlm_interval_extent(struct ldlm_interval *node)
 245 {
 246         struct ldlm_lock *lock;
 247         LASSERT(!list_empty(&node->li_group));
 248
 249         lock = list_entry(node->li_group.next, struct ldlm_lock,
 250                               l_sl_policy);
 251         return &lock->l_policy_data.l_extent;
 252 }
 253
 254 int ldlm_init(void);
 255 void ldlm_exit(void);
 256
 257 enum ldlm_policy_res {
 258         LDLM_POLICY_CANCEL_LOCK,
 259         LDLM_POLICY_KEEP_LOCK,
 260         LDLM_POLICY_SKIP_LOCK
 261 };
 262
 263 #define LDLM_POOL_PROC_READER_SEQ_SHOW(var, type)                       \
 264         static int lprocfs_##var##_seq_show(struct seq_file *m, void *v)\
 265         {                                                               \
 266                 struct ldlm_pool *pl = m->private;                      \
 267                 type tmp;                                               \
 268                                                                         \
 269                 spin_lock(&pl->pl_lock);                                \
 270                 tmp = pl->pl_##var;                                     \
 271                 spin_unlock(&pl->pl_lock);                              \
 272                                                                         \
 273                 return lprocfs_uint_seq_show(m, &tmp);                  \
 274         }                                                               \
 275         struct __##var##__dummy_read {;} /* semicolon catcher */
 276
 277 #define LDLM_POOL_PROC_WRITER(var, type)                                \
 278         static int lprocfs_wr_##var(struct file *file,                  \
 279                              const char __user *buffer,                 \
 280                              unsigned long count, void *data)           \
 281         {                                                               \
 282                 struct ldlm_pool *pl = data;                            \
 283                 type tmp;                                               \
 284                 int rc;                                                 \
 285                                                                         \
 286                 rc = lprocfs_wr_uint(file, buffer, count, &tmp);        \
 287                 if (rc < 0) {                                           \
 288                         CERROR("Can't parse user input, rc = %d\n", rc);\
 289                         return rc;                                      \
 290                 }                                                       \
 291                                                                         \
 292                 spin_lock(&pl->pl_lock);                                \
 293                 pl->pl_##var = tmp;                                     \
 294                 spin_unlock(&pl->pl_lock);                              \
 295                                                                         \
 296                 return rc;                                              \
 297         }                                                               \
 298         struct __##var##__dummy_write {;} /* semicolon catcher */
 299
 300 static inline void
 301 ldlm_add_var(struct lprocfs_vars *vars, struct proc_dir_entry *proc_dir,
 302              const char *name, void *data, const struct file_operations *ops)
 303 {
 304         snprintf((char *)vars->name, MAX_STRING_SIZE, "%s", name);
 305         vars->data = data;
 306         vars->fops = ops;
 307         lprocfs_add_vars(proc_dir, vars, NULL);
 308 }
 309
 310 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
 311 {
 312         int ret = 0;
 313
 314         lock_res_and_lock(lock);
 315         if ((lock->l_req_mode == lock->l_granted_mode) &&
 316              !ldlm_is_cp_reqd(lock))
 317                 ret = 1;
 318         else if (ldlm_is_failed(lock) || ldlm_is_cancel(lock))
 319                 ret = 1;
 320         unlock_res_and_lock(lock);
 321
 322         return ret;
 323 }
 324
 325 typedef void (*ldlm_policy_wire_to_local_t)(const union ldlm_wire_policy_data *,
 326                                             union ldlm_policy_data *);
 327 typedef void (*ldlm_policy_local_to_wire_t)(const union ldlm_policy_data *,
 328                                             union ldlm_wire_policy_data *);
 329 void ldlm_plain_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 330                                      union ldlm_policy_data *lpolicy);
 331 void ldlm_plain_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 332                                      union ldlm_wire_policy_data *wpolicy);
 333 void ldlm_ibits_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 334                                      union ldlm_policy_data *lpolicy);
 335 void ldlm_ibits_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 336                                      union ldlm_wire_policy_data *wpolicy);
 337 void ldlm_extent_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 338                                       union ldlm_policy_data *lpolicy);
 339 void ldlm_extent_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 340                                       union ldlm_wire_policy_data *wpolicy);
 341 void ldlm_flock_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
 342                                      union ldlm_policy_data *lpolicy);
 343 void ldlm_flock_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
 344                                      union ldlm_wire_policy_data *wpolicy);
 345
 346 /* ldlm_reclaim.c */
 347 extern __u64 ldlm_watermark_low;
 348 extern __u64 ldlm_watermark_high;
 349 int ldlm_reclaim_setup(void);
 350 void ldlm_reclaim_cleanup(void);
 351 void ldlm_reclaim_add(struct ldlm_lock *lock);
 352 void ldlm_reclaim_del(struct ldlm_lock *lock);
 353 bool ldlm_reclaim_full(void);