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  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  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 atomic_t ldlm_srv_namespace_nr;
  40 extern atomic_t ldlm_cli_namespace_nr;
  41 extern struct semaphore ldlm_srv_namespace_lock;
  42 extern struct list_head ldlm_srv_namespace_list;
  43 extern struct semaphore ldlm_cli_namespace_lock;
  44 extern struct list_head ldlm_cli_namespace_list;
  45
  46 static inline atomic_t *ldlm_namespace_nr(ldlm_side_t client)
  47 {
  48         return client == LDLM_NAMESPACE_SERVER ?
  49                 &ldlm_srv_namespace_nr : &ldlm_cli_namespace_nr;
  50 }
  51
  52 static inline struct list_head *ldlm_namespace_list(ldlm_side_t client)
  53 {
  54         return client == LDLM_NAMESPACE_SERVER ?
  55                 &ldlm_srv_namespace_list : &ldlm_cli_namespace_list;
  56 }
  57
  58 static inline struct semaphore *ldlm_namespace_lock(ldlm_side_t client)
  59 {
  60         return client == LDLM_NAMESPACE_SERVER ?
  61                 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
  62 }
  63
  64 /* ldlm_request.c */
  65 typedef enum {
  66         LDLM_ASYNC,
  67         LDLM_SYNC,
  68 } ldlm_sync_t;
  69
  70 /* Cancel lru flag, it indicates we cancel aged locks. */
  71 enum {
  72         LDLM_CANCEL_AGED   = 1 << 0, /* Cancel aged locks (non lru resize). */
  73         LDLM_CANCEL_PASSED = 1 << 1, /* Cancel passed number of locks. */
  74         LDLM_CANCEL_SHRINK = 1 << 2, /* Cancel locks from shrinker. */
  75         LDLM_CANCEL_LRUR   = 1 << 3  /* Cancel locks from lru resize. */
  76 };
  77
  78 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr, ldlm_sync_t sync,
  79                     int flags);
  80 int ldlm_cancel_lru_local(struct ldlm_namespace *ns, struct list_head *cancels,
  81                           int count, int max, int cancel_flags, int flags);
  82 extern int ldlm_enqueue_min;
  83 int ldlm_get_enq_timeout(struct ldlm_lock *lock);
  84
  85 /* ldlm_resource.c */
  86 int ldlm_resource_putref_locked(struct ldlm_resource *res);
  87 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
  88                                      struct ldlm_lock *new);
  89 void ldlm_namespace_free_prior(struct ldlm_namespace *ns,
  90                                struct obd_import *imp, int force);
  91 void ldlm_namespace_free_post(struct ldlm_namespace *ns);
  92 /* ldlm_lock.c */
  93
  94 /* Number of blocking/completion callbacks that will be sent in
  95  * parallel (see bug 11301). */
  96 #define PARALLEL_AST_LIMIT      200
  97
  98 struct ldlm_cb_set_arg {
  99         struct ptlrpc_request_set *set;
 100         atomic_t restart;
 101         __u32 type; /* LDLM_BL_CALLBACK or LDLM_CP_CALLBACK */
 102 };
 103
 104 typedef enum {
 105         LDLM_WORK_BL_AST,
 106         LDLM_WORK_CP_AST,
 107         LDLM_WORK_REVOKE_AST
 108 } ldlm_desc_ast_t;
 109
 110 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
 111 struct ldlm_lock *
 112 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
 113                  ldlm_type_t type, ldlm_mode_t,
 114                  const struct ldlm_callback_suite *cbs,
 115                  void *data, __u32 lvb_len);
 116 ldlm_error_t ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
 117                                void *cookie, int *flags);
 118 void ldlm_lock_addref_internal(struct ldlm_lock *, __u32 mode);
 119 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, __u32 mode);
 120 void ldlm_lock_decref_internal(struct ldlm_lock *, __u32 mode);
 121 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, __u32 mode);
 122 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
 123                                 struct list_head *work_list);
 124 int ldlm_reprocess_queue(struct ldlm_resource *res, struct list_head *queue,
 125                          struct list_head *work_list);
 126 int ldlm_run_ast_work(struct list_head *rpc_list, ldlm_desc_ast_t ast_type);
 127 int ldlm_lock_remove_from_lru(struct ldlm_lock *lock);
 128 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
 129 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
 130 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
 131 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
 132 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
 133
 134 /* ldlm_lockd.c */
 135 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
 136                            struct ldlm_lock *lock);
 137 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
 138                            struct list_head *cancels, int count);
 139
 140 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
 141                              struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
 142
 143 /* ldlm_plain.c */
 144 int ldlm_process_plain_lock(struct ldlm_lock *lock, int *flags, int first_enq,
 145                             ldlm_error_t *err, struct list_head *work_list);
 146
 147 /* ldlm_extent.c */
 148 int ldlm_process_extent_lock(struct ldlm_lock *lock, int *flags, int first_enq,
 149                              ldlm_error_t *err, struct list_head *work_list);
 150 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
 151 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
 152
 153 /* ldlm_flock.c */
 154 int ldlm_process_flock_lock(struct ldlm_lock *req, int *flags, int first_enq,
 155                             ldlm_error_t *err, struct list_head *work_list);
 156
 157 /* ldlm_inodebits.c */
 158 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, int *flags,
 159                                 int first_enq, ldlm_error_t *err,
 160                                 struct list_head *work_list);
 161
 162 /* l_lock.c */
 163 void l_check_ns_lock(struct ldlm_namespace *ns);
 164 void l_check_no_ns_lock(struct ldlm_namespace *ns);
 165
 166 extern cfs_proc_dir_entry_t *ldlm_svc_proc_dir;
 167 extern cfs_proc_dir_entry_t *ldlm_type_proc_dir;
 168
 169 struct ldlm_state {
 170         struct ptlrpc_service *ldlm_cb_service;
 171         struct ptlrpc_service *ldlm_cancel_service;
 172         struct ptlrpc_client *ldlm_client;
 173         struct ptlrpc_connection *ldlm_server_conn;
 174         struct ldlm_bl_pool *ldlm_bl_pool;
 175 };
 176
 177 /* interval tree, for LDLM_EXTENT. */
 178 extern cfs_mem_cache_t *ldlm_interval_slab; /* slab cache for ldlm_interval */
 179 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
 180 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
 181 extern struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
 182 extern void ldlm_interval_free(struct ldlm_interval *node);
 183 /* this function must be called with res lock held */
 184 static inline struct ldlm_extent *
 185 ldlm_interval_extent(struct ldlm_interval *node)
 186 {
 187         struct ldlm_lock *lock;
 188         LASSERT(!list_empty(&node->li_group));
 189
 190         lock = list_entry(node->li_group.next, struct ldlm_lock, l_sl_policy);
 191         return &lock->l_policy_data.l_extent;
 192 }
 193
 194 int ldlm_init(void);
 195 void ldlm_exit(void);
 196
 197 enum ldlm_policy_res {
 198         LDLM_POLICY_CANCEL_LOCK,
 199         LDLM_POLICY_KEEP_LOCK
 200 };
 201
 202 typedef enum ldlm_policy_res ldlm_policy_res_t;
 203
 204 #define LDLM_POOL_PROC_READER(var, type)                                    \
 205         static int lprocfs_rd_##var(char *page, char **start, off_t off,    \
 206                                     int count, int *eof, void *data)        \
 207         {                                                                   \
 208                 struct ldlm_pool *pl = data;                                \
 209                 type tmp;                                                   \
 210                                                                             \
 211                 spin_lock(&pl->pl_lock);                                    \
 212                 tmp = pl->pl_##var;                                         \
 213                 spin_unlock(&pl->pl_lock);                                  \
 214                                                                             \
 215                 return lprocfs_rd_uint(page, start, off, count, eof, &tmp); \
 216         }                                                                   \
 217         struct __##var##__dummy_read {;} /* semicolon catcher */
 218
 219 #define LDLM_POOL_PROC_WRITER(var, type)                                    \
 220         int lprocfs_wr_##var(struct file *file, const char *buffer,         \
 221                              unsigned long count, void *data)               \
 222         {                                                                   \
 223                 struct ldlm_pool *pl = data;                                \
 224                 type tmp;                                                   \
 225                 int rc;                                                     \
 226                                                                             \
 227                 rc = lprocfs_wr_uint(file, buffer, count, &tmp);            \
 228                 if (rc) {                                                   \
 229                         CERROR("Can't parse user input, rc = %d\n", rc);    \
 230                         return rc;                                          \
 231                 }                                                           \
 232                                                                             \
 233                 spin_lock(&pl->pl_lock);                                    \
 234                 pl->pl_##var = tmp;                                         \
 235                 spin_unlock(&pl->pl_lock);                                  \
 236                                                                             \
 237                 return rc;                                                  \
 238         }                                                                   \
 239         struct __##var##__dummy_write {;} /* semicolon catcher */
 240
 241 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
 242 {
 243         int ret = 0;
 244
 245         lock_res_and_lock(lock);
 246         if (((lock->l_req_mode == lock->l_granted_mode) &&
 247              !(lock->l_flags & LDLM_FL_CP_REQD)) ||
 248             (lock->l_flags & LDLM_FL_FAILED))
 249                 ret = 1;
 250         unlock_res_and_lock(lock);
 251
 252         return ret;
 253 }