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