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 Whamcloud, Inc.
  33  *
  34  */
  35 /*
  36  * This file is part of Lustre, http://www.lustre.org/
  37  * Lustre is a trademark of Sun Microsystems, Inc.
  38  */
  39
  40 #define MAX_STRING_SIZE 128
  41
  42 extern cfs_atomic_t ldlm_srv_namespace_nr;
  43 extern cfs_atomic_t ldlm_cli_namespace_nr;
  44 extern cfs_semaphore_t ldlm_srv_namespace_lock;
  45 extern cfs_list_t ldlm_srv_namespace_list;
  46 extern cfs_semaphore_t ldlm_cli_namespace_lock;
  47 extern cfs_list_t ldlm_cli_namespace_list;
  48
  49 static inline int ldlm_res_eq(const struct ldlm_res_id *res0,
  50                        const struct ldlm_res_id *res1)
  51 {
  52         return !memcmp(res0, res1, sizeof(*res0));
  53 }
  54
  55 static inline cfs_atomic_t *ldlm_namespace_nr(ldlm_side_t client)
  56 {
  57         return client == LDLM_NAMESPACE_SERVER ?
  58                 &ldlm_srv_namespace_nr : &ldlm_cli_namespace_nr;
  59 }
  60
  61 static inline cfs_list_t *ldlm_namespace_list(ldlm_side_t client)
  62 {
  63         return client == LDLM_NAMESPACE_SERVER ?
  64                 &ldlm_srv_namespace_list : &ldlm_cli_namespace_list;
  65 }
  66
  67 static inline cfs_semaphore_t *ldlm_namespace_lock(ldlm_side_t client)
  68 {
  69         return client == LDLM_NAMESPACE_SERVER ?
  70                 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
  71 }
  72
  73 /* ldlm_request.c */
  74 typedef enum {
  75         LDLM_ASYNC,
  76         LDLM_SYNC,
  77 } ldlm_sync_t;
  78
  79 /* Cancel lru flag, it indicates we cancel aged locks. */
  80 enum {
  81         LDLM_CANCEL_AGED   = 1 << 0, /* Cancel aged locks (non lru resize). */
  82         LDLM_CANCEL_PASSED = 1 << 1, /* Cancel passed number of locks. */
  83         LDLM_CANCEL_SHRINK = 1 << 2, /* Cancel locks from shrinker. */
  84         LDLM_CANCEL_LRUR   = 1 << 3, /* Cancel locks from lru resize. */
  85         LDLM_CANCEL_NO_WAIT = 1 << 4 /* Cancel locks w/o blocking (neither
  86                                       * sending nor waiting for any rpcs) */
  87 };
  88
  89 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr, ldlm_sync_t sync,
  90                     int flags);
  91 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
  92                           cfs_list_t *cancels, int count, int max,
  93                           ldlm_cancel_flags_t cancel_flags, int flags);
  94 extern int ldlm_enqueue_min;
  95 int ldlm_get_enq_timeout(struct ldlm_lock *lock);
  96
  97 /* ldlm_resource.c */
  98 int ldlm_resource_putref_locked(struct ldlm_resource *res);
  99 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
 100                                      struct ldlm_lock *new);
 101 void ldlm_namespace_free_prior(struct ldlm_namespace *ns,
 102                                struct obd_import *imp, int force);
 103 void ldlm_namespace_free_post(struct ldlm_namespace *ns);
 104 /* ldlm_lock.c */
 105
 106 struct ldlm_cb_set_arg {
 107         int          type;      /* LDLM_BL_CALLBACK or LDLM_CP_CALLBACK */
 108         unsigned int threshold; /* threshold to wake up the waiting proc */
 109         cfs_atomic_t rpcs;      /* # of inflight rpcs in set */
 110         cfs_atomic_t restart;
 111         cfs_waitq_t  waitq;
 112 };
 113
 114 typedef enum {
 115         LDLM_WORK_BL_AST,
 116         LDLM_WORK_CP_AST,
 117         LDLM_WORK_REVOKE_AST
 118 } ldlm_desc_ast_t;
 119
 120 void ldlm_grant_lock(struct ldlm_lock *lock, cfs_list_t *work_list);
 121 struct ldlm_lock *
 122 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
 123                  ldlm_type_t type, ldlm_mode_t,
 124                  const struct ldlm_callback_suite *cbs,
 125                  void *data, __u32 lvb_len);
 126 ldlm_error_t ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
 127                                void *cookie, int *flags);
 128 void ldlm_lock_addref_internal(struct ldlm_lock *, __u32 mode);
 129 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, __u32 mode);
 130 void ldlm_lock_decref_internal(struct ldlm_lock *, __u32 mode);
 131 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, __u32 mode);
 132 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
 133                             cfs_list_t *work_list);
 134 int ldlm_reprocess_queue(struct ldlm_resource *res, cfs_list_t *queue,
 135                          cfs_list_t *work_list);
 136 int ldlm_run_ast_work(struct ldlm_namespace *ns, cfs_list_t *rpc_list,
 137                       ldlm_desc_ast_t ast_type);
 138 int ldlm_lock_remove_from_lru(struct ldlm_lock *lock);
 139 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
 140 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
 141 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
 142 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
 143 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
 144
 145 void ldlm_cancel_locks_for_export(struct obd_export *export);
 146
 147 /* ldlm_lockd.c */
 148 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
 149                            struct ldlm_lock *lock);
 150 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
 151                            cfs_list_t *cancels, int count, int mode);
 152
 153 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
 154                              struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
 155
 156 /* ldlm_plain.c */
 157 int ldlm_process_plain_lock(struct ldlm_lock *lock, int *flags, int first_enq,
 158                             ldlm_error_t *err, cfs_list_t *work_list);
 159
 160 /* ldlm_extent.c */
 161 int ldlm_process_extent_lock(struct ldlm_lock *lock, int *flags, int first_enq,
 162                              ldlm_error_t *err, cfs_list_t *work_list);
 163 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
 164 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
 165
 166 /* ldlm_flock.c */
 167 int ldlm_process_flock_lock(struct ldlm_lock *req, int *flags, int first_enq,
 168                             ldlm_error_t *err, cfs_list_t *work_list);
 169
 170 /* ldlm_inodebits.c */
 171 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, int *flags,
 172                                 int first_enq, ldlm_error_t *err,
 173                                 cfs_list_t *work_list);
 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 cfs_proc_dir_entry_t *ldlm_svc_proc_dir;
 180 extern cfs_proc_dir_entry_t *ldlm_type_proc_dir;
 181
 182 struct ldlm_state {
 183         struct ptlrpc_service *ldlm_cb_service;
 184         struct ptlrpc_service *ldlm_cancel_service;
 185         struct ptlrpc_client *ldlm_client;
 186         struct ptlrpc_connection *ldlm_server_conn;
 187         struct ldlm_bl_pool *ldlm_bl_pool;
 188 };
 189
 190 /* interval tree, for LDLM_EXTENT. */
 191 extern cfs_mem_cache_t *ldlm_interval_slab; /* slab cache for ldlm_interval */
 192 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
 193 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
 194 extern struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
 195 extern void ldlm_interval_free(struct ldlm_interval *node);
 196 /* this function must be called with res lock held */
 197 static inline struct ldlm_extent *
 198 ldlm_interval_extent(struct ldlm_interval *node)
 199 {
 200         struct ldlm_lock *lock;
 201         LASSERT(!cfs_list_empty(&node->li_group));
 202
 203         lock = cfs_list_entry(node->li_group.next, struct ldlm_lock,
 204                               l_sl_policy);
 205         return &lock->l_policy_data.l_extent;
 206 }
 207
 208 int ldlm_init(void);
 209 void ldlm_exit(void);
 210
 211 enum ldlm_policy_res {
 212         LDLM_POLICY_CANCEL_LOCK,
 213         LDLM_POLICY_KEEP_LOCK,
 214         LDLM_POLICY_SKIP_LOCK
 215 };
 216
 217 typedef enum ldlm_policy_res ldlm_policy_res_t;
 218
 219 #define LDLM_POOL_PROC_READER(var, type)                                    \
 220         static int lprocfs_rd_##var(char *page, char **start, off_t off,    \
 221                                     int count, int *eof, void *data)        \
 222         {                                                                   \
 223                 struct ldlm_pool *pl = data;                                \
 224                 type tmp;                                                   \
 225                                                                             \
 226                 cfs_spin_lock(&pl->pl_lock);                                \
 227                 tmp = pl->pl_##var;                                         \
 228                 cfs_spin_unlock(&pl->pl_lock);                              \
 229                                                                             \
 230                 return lprocfs_rd_uint(page, start, off, count, eof, &tmp); \
 231         }                                                                   \
 232         struct __##var##__dummy_read {;} /* semicolon catcher */
 233
 234 #define LDLM_POOL_PROC_WRITER(var, type)                                    \
 235         int lprocfs_wr_##var(struct file *file, const char *buffer,         \
 236                              unsigned long count, void *data)               \
 237         {                                                                   \
 238                 struct ldlm_pool *pl = data;                                \
 239                 type tmp;                                                   \
 240                 int rc;                                                     \
 241                                                                             \
 242                 rc = lprocfs_wr_uint(file, buffer, count, &tmp);            \
 243                 if (rc < 0) {                                               \
 244                         CERROR("Can't parse user input, rc = %d\n", rc);    \
 245                         return rc;                                          \
 246                 }                                                           \
 247                                                                             \
 248                 cfs_spin_lock(&pl->pl_lock);                                \
 249                 pl->pl_##var = tmp;                                         \
 250                 cfs_spin_unlock(&pl->pl_lock);                              \
 251                                                                             \
 252                 return rc;                                                  \
 253         }                                                                   \
 254         struct __##var##__dummy_write {;} /* semicolon catcher */
 255
 256 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
 257 {
 258         int ret = 0;
 259
 260         lock_res_and_lock(lock);
 261         if (((lock->l_req_mode == lock->l_granted_mode) &&
 262              !(lock->l_flags & LDLM_FL_CP_REQD)) ||
 263             (lock->l_flags & (LDLM_FL_FAILED | LDLM_FL_CANCEL)))
 264                 ret = 1;
 265         unlock_res_and_lock(lock);
 266
 267         return ret;
 268 }
 269
 270 typedef void (*ldlm_policy_wire_to_local_t)(const ldlm_wire_policy_data_t *,
 271                                             ldlm_policy_data_t *);
 272
 273 typedef void (*ldlm_policy_local_to_wire_t)(const ldlm_policy_data_t *,
 274                                             ldlm_wire_policy_data_t *);
 275
 276 void ldlm_plain_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
 277                                      ldlm_policy_data_t *lpolicy);
 278 void ldlm_plain_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 279                                      ldlm_wire_policy_data_t *wpolicy);
 280 void ldlm_ibits_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
 281                                      ldlm_policy_data_t *lpolicy);
 282 void ldlm_ibits_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 283                                      ldlm_wire_policy_data_t *wpolicy);
 284 void ldlm_extent_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
 285                                      ldlm_policy_data_t *lpolicy);
 286 void ldlm_extent_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 287                                      ldlm_wire_policy_data_t *wpolicy);
 288 void ldlm_flock_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
 289                                      ldlm_policy_data_t *lpolicy);
 290 void ldlm_flock_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
 291                                      ldlm_wire_policy_data_t *wpolicy);