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