lustre/ldlm/ldlm_internal.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  *
  32  * Copyright (c) 2011, 2012, Whamcloud, Inc.
  33  */
  34 /*
  35  * This file is part of Lustre, http://www.lustre.org/
  36  * Lustre is a trademark of Sun Microsystems, Inc.
  37  */
  38
  39 #define MAX_STRING_SIZE 128
  40
  41 extern cfs_atomic_t ldlm_srv_namespace_nr;
  42 extern cfs_atomic_t ldlm_cli_namespace_nr;
  43 extern cfs_mutex_t ldlm_srv_namespace_lock;
  44 extern cfs_list_t ldlm_srv_namespace_list;
  45 extern cfs_mutex_t ldlm_cli_namespace_lock;
  46 extern cfs_list_t ldlm_cli_namespace_list;
  47
  48 static inline cfs_atomic_t *ldlm_namespace_nr(ldlm_side_t client)
  49 {
  50         return client == LDLM_NAMESPACE_SERVER ?
  51                 &ldlm_srv_namespace_nr : &ldlm_cli_namespace_nr;
  52 }
  53
  54 static inline cfs_list_t *ldlm_namespace_list(ldlm_side_t client)
  55 {
  56         return client == LDLM_NAMESPACE_SERVER ?
  57                 &ldlm_srv_namespace_list : &ldlm_cli_namespace_list;
  58 }
  59
  60 static inline cfs_mutex_t *ldlm_namespace_lock(ldlm_side_t client)
  61 {
  62         return client == LDLM_NAMESPACE_SERVER ?
  63                 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
  64 }
  65
  66 /* ldlm_request.c */
  67 typedef enum {
  68         LDLM_ASYNC,
  69         LDLM_SYNC,
  70 } ldlm_sync_t;
  71
  72 /* Cancel lru flag, it indicates we cancel aged locks. */
  73 enum {
  74         LDLM_CANCEL_AGED   = 1 << 0, /* Cancel aged locks (non lru resize). */
  75         LDLM_CANCEL_PASSED = 1 << 1, /* Cancel passed number of locks. */
  76         LDLM_CANCEL_SHRINK = 1 << 2, /* Cancel locks from shrinker. */
  77         LDLM_CANCEL_LRUR   = 1 << 3, /* Cancel locks from lru resize. */
  78         LDLM_CANCEL_NO_WAIT = 1 << 4 /* Cancel locks w/o blocking (neither
  79                                       * sending nor waiting for any rpcs) */
  80 };
  81
  82 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr, ldlm_sync_t sync,
  83                     int flags);
  84 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
  85                           cfs_list_t *cancels, int count, int max,
  86                           ldlm_cancel_flags_t cancel_flags, int flags);
  87 extern int ldlm_enqueue_min;
  88 int ldlm_get_enq_timeout(struct ldlm_lock *lock);
  89
  90 /* ldlm_resource.c */
  91 int ldlm_resource_putref_locked(struct ldlm_resource *res);
  92 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
  93                                      struct ldlm_lock *new);
  94 void ldlm_namespace_free_prior(struct ldlm_namespace *ns,
  95                                struct obd_import *imp, int force);
  96 void ldlm_namespace_free_post(struct ldlm_namespace *ns);
  97 /* ldlm_lock.c */
  98
  99 struct ldlm_cb_set_arg {
 100         int          type;      /* LDLM_BL_CALLBACK or LDLM_CP_CALLBACK */
 101         unsigned int threshold; /* threshold to wake up the waiting proc */
 102         cfs_atomic_t rpcs;      /* # of inflight rpcs in set */
 103         cfs_atomic_t restart;
 104         cfs_atomic_t refcount;
 105         cfs_waitq_t  waitq;
 106 };
 107
 108 static inline void ldlm_csa_put(struct ldlm_cb_set_arg *arg)
 109 {
 110         if (cfs_atomic_dec_and_test(&arg->refcount)) {
 111                 LASSERT(cfs_atomic_read(&arg->rpcs) == 0);
 112
 113                 OBD_FREE_PTR(arg);
 114         }
 115 }
 116
 117 typedef enum {
 118         LDLM_WORK_BL_AST,
 119         LDLM_WORK_CP_AST,
 120         LDLM_WORK_REVOKE_AST
 121 } ldlm_desc_ast_t;
 122
 123 void ldlm_grant_lock(struct ldlm_lock *lock, cfs_list_t *work_list);
 124 struct ldlm_lock *
 125 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
 126                  ldlm_type_t type, ldlm_mode_t,
 127                  const struct ldlm_callback_suite *cbs,
 128                  void *data, __u32 lvb_len);
 129 ldlm_error_t ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
 130                                void *cookie, int *flags);
 131 void ldlm_lock_addref_internal(struct ldlm_lock *, __u32 mode);
 132 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, __u32 mode);
 133 void ldlm_lock_decref_internal(struct ldlm_lock *, __u32 mode);
 134 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, __u32 mode);
 135 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
 136                             cfs_list_t *work_list);
 137 #ifdef HAVE_SERVER_SUPPORT
 138 int ldlm_reprocess_queue(struct ldlm_resource *res, cfs_list_t *queue,
 139                          cfs_list_t *work_list);
 140 #endif
 141 int ldlm_run_ast_work(struct ldlm_namespace *ns, cfs_list_t *rpc_list,
 142                       ldlm_desc_ast_t ast_type);
 143 int ldlm_lock_remove_from_lru(struct ldlm_lock *lock);
 144 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
 145 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
 146 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
 147 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
 148 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
 149
 150 void ldlm_cancel_locks_for_export(struct obd_export *export);
 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, struct ldlm_lock_desc *ld,
 156                            cfs_list_t *cancels, int count, int mode);
 157
 158 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
 159                              struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
 160
 161 #ifdef HAVE_SERVER_SUPPORT
 162 /* ldlm_plain.c */
 163 int ldlm_process_plain_lock(struct ldlm_lock *lock, int *flags, int first_enq,
 164                             ldlm_error_t *err, cfs_list_t *work_list);
 165
 166 /* ldlm_inodebits.c */
 167 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, int *flags,
 168                                 int first_enq, ldlm_error_t *err,
 169                                 cfs_list_t *work_list);
 170 #endif
 171
 172 /* ldlm_extent.c */
 173 #ifdef HAVE_SERVER_SUPPORT
 174 int ldlm_process_extent_lock(struct ldlm_lock *lock, int *flags, int first_enq,
 175                              ldlm_error_t *err, cfs_list_t *work_list);
 176 #endif
 177 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
 178 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
 179
 180 /* ldlm_flock.c */
 181 int ldlm_process_flock_lock(struct ldlm_lock *req, int *flags, int first_enq,
 182                             ldlm_error_t *err, cfs_list_t *work_list);
 183
 184 /* l_lock.c */
 185 void l_check_ns_lock(struct ldlm_namespace *ns);
 186 void l_check_no_ns_lock(struct ldlm_namespace *ns);
 187
 188 extern cfs_proc_dir_entry_t *ldlm_svc_proc_dir;
 189 extern cfs_proc_dir_entry_t *ldlm_type_proc_dir;
 190
 191 struct ldlm_state {
 192         struct ptlrpc_service *ldlm_cb_service;
 193         struct ptlrpc_service *ldlm_cancel_service;
 194         struct ptlrpc_client *ldlm_client;
 195         struct ptlrpc_connection *ldlm_server_conn;
 196         struct ldlm_bl_pool *ldlm_bl_pool;
 197 };
 198
 199 /* interval tree, for LDLM_EXTENT. */
 200 extern cfs_mem_cache_t *ldlm_interval_slab; /* slab cache for ldlm_interval */
 201 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
 202 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
 203 extern struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
 204 extern void ldlm_interval_free(struct ldlm_interval *node);
 205 /* this function must be called with res lock held */
 206 static inline struct ldlm_extent *
 207 ldlm_interval_extent(struct ldlm_interval *node)
 208 {
 209         struct ldlm_lock *lock;
 210         LASSERT(!cfs_list_empty(&node->li_group));
 211
 212         lock = cfs_list_entry(node->li_group.next, struct ldlm_lock,
 213                               l_sl_policy);
 214         return &lock->l_policy_data.l_extent;
 215 }
 216
 217 int ldlm_init(void);
 218 void ldlm_exit(void);
 219
 220 enum ldlm_policy_res {
 221         LDLM_POLICY_CANCEL_LOCK,
 222         LDLM_POLICY_KEEP_LOCK,
 223         LDLM_POLICY_SKIP_LOCK
 224 };
 225
 226 typedef enum ldlm_policy_res ldlm_policy_res_t;
 227
 228 #define LDLM_POOL_PROC_READER(var, type)                                    \
 229         static int lprocfs_rd_##var(char *page, char **start, off_t off,    \
 230                                     int count, int *eof, void *data)        \
 231         {                                                                   \
 232                 struct ldlm_pool *pl = data;                                \
 233                 type tmp;                                                   \
 234                                                                             \
 235                 cfs_spin_lock(&pl->pl_lock);                                \
 236                 tmp = pl->pl_##var;                                         \
 237                 cfs_spin_unlock(&pl->pl_lock);                              \
 238                                                                             \
 239                 return lprocfs_rd_uint(page, start, off, count, eof, &tmp); \
 240         }                                                                   \
 241         struct __##var##__dummy_read {;} /* semicolon catcher */
 242
 243 #define LDLM_POOL_PROC_WRITER(var, type)                                    \
 244         int lprocfs_wr_##var(struct file *file, const char *buffer,         \
 245                              unsigned long count, void *data)               \
 246         {                                                                   \
 247                 struct ldlm_pool *pl = data;                                \
 248                 type tmp;                                                   \
 249                 int rc;                                                     \
 250                                                                             \
 251                 rc = lprocfs_wr_uint(file, buffer, count, &tmp);            \
 252                 if (rc < 0) {                                               \
 253                         CERROR("Can't parse user input, rc = %d\n", rc);    \
 254                         return rc;                                          \
 255                 }                                                           \
 256                                                                             \
 257                 cfs_spin_lock(&pl->pl_lock);                                \
 258                 pl->pl_##var = tmp;                                         \
 259                 cfs_spin_unlock(&pl->pl_lock);                              \
 260                                                                             \
 261                 return rc;                                                  \
 262         }                                                                   \
 263         struct __##var##__dummy_write {;} /* semicolon catcher */
 264
 265 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
 266 {
 267         int ret = 0;
 268
 269         lock_res_and_lock(lock);
 270         if (((lock->l_req_mode == lock->l_granted_mode) &&
 271              !(lock->l_flags & LDLM_FL_CP_REQD)) ||
 272             (lock->l_flags & (LDLM_FL_FAILED | LDLM_FL_CANCEL)))
 273                 ret = 1;
 274         unlock_res_and_lock(lock);
 275
 276         return ret;
 277 }
 278
 279 typedef void (*ldlm_policy_wire_to_local_t)(const ldlm_wire_policy_data_t *,
 280                                             ldlm_policy_data_t *);
 281
 282 typedef void (*ldlm_policy_local_to_wire_t)(const ldlm_policy_data_t *,
 283                                             ldlm_wire_policy_data_t *);
 284
 285 void ldlm_plain_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
 286                                      ldlm_policy_data_t *lpolicy);
 287 void ldlm_plain_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 288                                      ldlm_wire_policy_data_t *wpolicy);
 289 void ldlm_ibits_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
 290                                      ldlm_policy_data_t *lpolicy);
 291 void ldlm_ibits_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 292                                      ldlm_wire_policy_data_t *wpolicy);
 293 void ldlm_extent_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
 294                                      ldlm_policy_data_t *lpolicy);
 295 void ldlm_extent_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 296                                      ldlm_wire_policy_data_t *wpolicy);
 297 void ldlm_flock_policy_wire18_to_local(const ldlm_wire_policy_data_t *wpolicy,
 298                                      ldlm_policy_data_t *lpolicy);
 299 void ldlm_flock_policy_wire21_to_local(const ldlm_wire_policy_data_t *wpolicy,
 300                                      ldlm_policy_data_t *lpolicy);
 301
 302 void ldlm_flock_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 303                                      ldlm_wire_policy_data_t *wpolicy);