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