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