lustre/include/linux/lustre_dlm.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  */
   4
   5 #ifndef _LUSTRE_DLM_H__
   6 #define _LUSTRE_DLM_H__
   7
   8 #ifdef __KERNEL__
   9
  10 #include <linux/obd_class.h>
  11 #include <linux/lustre_net.h>
  12
  13 #define OBD_LDLM_DEVICENAME  "ldlm"
  14
  15 typedef enum {
  16         ELDLM_OK = 0,
  17
  18         ELDLM_LOCK_CHANGED = 300,
  19         ELDLM_LOCK_ABORTED = 301,
  20         ELDLM_RESOURCE_FREED = 302,
  21
  22         ELDLM_NAMESPACE_EXISTS = 400,
  23         ELDLM_BAD_NAMESPACE    = 401
  24 } ldlm_error_t;
  25
  26 #define LDLM_NAMESPACE_SERVER 0
  27 #define LDLM_NAMESPACE_CLIENT 1
  28
  29 #define LDLM_FL_LOCK_CHANGED   (1 << 0)
  30 #define LDLM_FL_BLOCK_GRANTED  (1 << 1)
  31 #define LDLM_FL_BLOCK_CONV     (1 << 2)
  32 #define LDLM_FL_BLOCK_WAIT     (1 << 3)
  33 #define LDLM_FL_DYING          (1 << 4)
  34 #define LDLM_FL_AST_SENT       (1 << 5)
  35 #define LDLM_FL_BLOCKED_PENDING (1 << 6)
  36
  37 #define L2B(c) (1 << c)
  38
  39 /* compatibility matrix */
  40 #define LCK_COMPAT_EX  L2B(LCK_NL)
  41 #define LCK_COMPAT_PW  (LCK_COMPAT_EX | L2B(LCK_CR))
  42 #define LCK_COMPAT_PR  (LCK_COMPAT_PW | L2B(LCK_PR))
  43 #define LCK_COMPAT_CW  (LCK_COMPAT_PW | L2B(LCK_CW))
  44 #define LCK_COMPAT_CR  (LCK_COMPAT_CW | L2B(LCK_PR) | L2B(LCK_PW))
  45 #define LCK_COMPAT_NL  (LCK_COMPAT_CR | L2B(LCK_EX))
  46
  47 static ldlm_mode_t lck_compat_array[] = {
  48         [LCK_EX] LCK_COMPAT_EX,
  49         [LCK_PW] LCK_COMPAT_PW,
  50         [LCK_PR] LCK_COMPAT_PR,
  51         [LCK_CW] LCK_COMPAT_CW,
  52         [LCK_CR] LCK_COMPAT_CR,
  53         [LCK_NL] LCK_COMPAT_NL
  54 };
  55
  56 static inline int lockmode_compat(ldlm_mode_t exist, ldlm_mode_t new)
  57 {
  58        if (exist < LCK_EX || exist > LCK_NL)
  59               LBUG();
  60        if (new < LCK_EX || new > LCK_NL)
  61               LBUG();
  62
  63        return (lck_compat_array[exist] & L2B(new));
  64 }
  65
  66 /*
  67  *
  68  * cluster name spaces
  69  *
  70  */
  71
  72 #define DLM_OST_NAMESPACE 1
  73 #define DLM_MDS_NAMESPACE 2
  74
  75 /* XXX
  76    - do we just separate this by security domains and use a prefix for
  77      multiple namespaces in the same domain?
  78    -
  79 */
  80
  81 struct ldlm_namespace {
  82         char                 *ns_name;
  83         struct ptlrpc_client  ns_rpc_client; /* used for revocation callbacks */
  84         __u32                 ns_client; /* is this a client-side lock tree? */
  85         struct list_head     *ns_hash; /* hash table for ns */
  86         __u32                 ns_refcount; /* count of resources in the hash */
  87         struct list_head      ns_root_list; /* all root resources in ns */
  88         struct lustre_lock    ns_lock; /* protects hash, refcount, list */
  89 };
  90
  91 /*
  92  *
  93  * Resource hash table
  94  *
  95  */
  96
  97 #define RES_HASH_BITS 14
  98 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
  99 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
 100
 101 struct ldlm_lock;
 102
 103 typedef int (*ldlm_lock_callback)(struct ldlm_lock *lock, struct ldlm_lock *new,
 104                                   void *data, __u32 data_len,
 105                                   struct ptlrpc_request **req);
 106
 107 struct ldlm_lock {
 108         struct ldlm_resource *l_resource;
 109         struct ldlm_lock     *l_parent;
 110         struct list_head      l_children;
 111         struct list_head      l_childof;
 112         struct list_head      l_res_link; /*position in one of three res lists*/
 113         atomic_t              l_refcount;
 114
 115         ldlm_mode_t           l_req_mode;
 116         ldlm_mode_t           l_granted_mode;
 117
 118         ldlm_lock_callback    l_completion_ast;
 119         ldlm_lock_callback    l_blocking_ast;
 120
 121         struct ptlrpc_connection *l_connection;
 122         struct ptlrpc_client *l_client;
 123         __u32                 l_flags;
 124         struct lustre_handle    l_remote_handle;
 125         void                 *l_data;
 126         __u32                 l_data_len;
 127         void                 *l_cookie;
 128         int                   l_cookie_len;
 129         struct ldlm_extent    l_extent;
 130         __u32                 l_version[RES_VERSION_SIZE];
 131
 132         __u32                 l_readers;
 133         __u32                 l_writers;
 134
 135         /* If the lock is granted, a process sleeps on this waitq to learn when
 136          * it's no longer in use.  If the lock is not granted, a process sleeps
 137          * on this waitq to learn when it becomes granted. */
 138         wait_queue_head_t     l_waitq;
 139 };
 140
 141 typedef int (*ldlm_res_compat)(struct ldlm_lock *child, struct ldlm_lock *new);
 142 typedef int (*ldlm_res_policy)(struct ldlm_lock *lock, void *req_cookie,
 143                                ldlm_mode_t mode, void *data);
 144
 145 #define LDLM_PLAIN       10
 146 #define LDLM_EXTENT      11
 147 #define LDLM_MDSINTENT   12
 148
 149 #define LDLM_MIN_TYPE 10
 150 #define LDLM_MAX_TYPE 12
 151
 152 extern ldlm_res_compat ldlm_res_compat_table [];
 153 extern ldlm_res_policy ldlm_res_policy_table [];
 154
 155 struct ldlm_resource {
 156         struct ldlm_namespace *lr_namespace;
 157         struct list_head       lr_hash;
 158         struct list_head       lr_rootlink; /* link all root resources in NS */
 159         struct ldlm_resource  *lr_parent;   /* 0 for a root resource */
 160         struct list_head       lr_children; /* list head for child resources */
 161         struct list_head       lr_childof;  /* part of child list of parent */
 162
 163         struct list_head       lr_granted;
 164         struct list_head       lr_converting;
 165         struct list_head       lr_waiting;
 166         ldlm_mode_t            lr_most_restr;
 167         __u32                  lr_type; /* PLAIN, EXTENT, or MDSINTENT */
 168         struct ldlm_resource  *lr_root;
 169         __u64                  lr_name[RES_NAME_SIZE];
 170         __u32                  lr_version[RES_VERSION_SIZE];
 171         atomic_t               lr_refcount;
 172         void                  *lr_tmp;
 173 };
 174
 175 static inline struct ldlm_extent *ldlm_res2extent(struct ldlm_resource *res)
 176 {
 177         return (struct ldlm_extent *)(res->lr_name);
 178 }
 179
 180 extern struct obd_ops ldlm_obd_ops;
 181
 182 #define LDLM_DEBUG(lock, format, a...)                          \
 183 do {                                                            \
 184         CDEBUG(D_DLMTRACE, "### " format                        \
 185                " (%s: lock %p mode %d/%d on res %Lu (rc %d) "   \
 186                " type %d remote %Lx)\n" , ## a,                 \
 187                lock->l_resource->lr_namespace->ns_name, lock,   \
 188                lock->l_granted_mode, lock->l_req_mode,          \
 189                lock->l_resource->lr_name[0],                    \
 190                atomic_read(&lock->l_resource->lr_refcount),     \
 191                lock->l_resource->lr_type,                       \
 192                lock->l_remote_handle.addr);                     \
 193 } while (0)
 194
 195 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
 196         CDEBUG(D_DLMTRACE, "### " format "\n" , ## a)
 197
 198 /* ldlm_extent.c */
 199 int ldlm_extent_compat(struct ldlm_lock *, struct ldlm_lock *);
 200 int ldlm_extent_policy(struct ldlm_lock *, void *, ldlm_mode_t, void *);
 201
 202 /* ldlm_lock.c */
 203 void ldlm_lock_free(struct ldlm_lock *lock);
 204 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
 205 void ldlm_lock_addref(struct ldlm_lock *lock, __u32 mode);
 206 void ldlm_lock_decref(struct ldlm_lock *lock, __u32 mode);
 207 void ldlm_grant_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
 208 int ldlm_local_lock_match(struct ldlm_namespace *ns, __u64 *res_id, __u32 type,
 209                           void *cookie, int cookielen, ldlm_mode_t mode,
 210                           struct lustre_handle *lockh);
 211 ldlm_error_t ldlm_local_lock_create(struct ldlm_namespace *ns,
 212                                     struct lustre_handle *parent_lock_handle,
 213                                     __u64 *res_id, __u32 type,
 214                                      ldlm_mode_t mode,
 215                                     void *data,
 216                                     __u32 data_len,
 217                                     struct lustre_handle *lockh);
 218 ldlm_error_t ldlm_local_lock_enqueue(struct lustre_handle *lockh,
 219                                      void *cookie, int cookie_len,
 220                                      int *flags,
 221                                      ldlm_lock_callback completion,
 222                                      ldlm_lock_callback blocking);
 223 struct ldlm_resource *ldlm_local_lock_convert(struct lustre_handle *lockh,
 224                                               int new_mode, int *flags);
 225 struct ldlm_resource *ldlm_local_lock_cancel(struct ldlm_lock *lock);
 226 void ldlm_reprocess_all(struct ldlm_resource *res);
 227 void ldlm_lock_dump(struct ldlm_lock *lock);
 228
 229 /* ldlm_test.c */
 230 int ldlm_test(struct obd_device *device, struct ptlrpc_connection *conn);
 231
 232 /* resource.c */
 233 struct ldlm_namespace *ldlm_namespace_new(char *name, __u32 local);
 234 int ldlm_namespace_free(struct ldlm_namespace *ns);
 235
 236 /* resource.c - internal */
 237 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
 238                                         struct ldlm_resource *parent,
 239                                         __u64 *name, __u32 type, int create);
 240 struct ldlm_resource *ldlm_resource_addref(struct ldlm_resource *res);
 241 int ldlm_resource_put(struct ldlm_resource *res);
 242 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
 243                             struct ldlm_lock *lock);
 244 void ldlm_resource_del_lock(struct ldlm_lock *lock);
 245 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
 246 void ldlm_resource_dump(struct ldlm_resource *res);
 247
 248 /* ldlm_request.c */
 249 int ldlm_cli_enqueue(struct ptlrpc_client *cl,
 250                      struct ptlrpc_connection *peer,
 251                      struct ptlrpc_request *req,
 252                      struct ldlm_namespace *ns,
 253                      struct lustre_handle *parent_lock_handle,
 254                      __u64 *res_id,
 255                      __u32 type,
 256                      void *cookie, int cookielen,
 257                      ldlm_mode_t mode,
 258                      int *flags,
 259                      ldlm_lock_callback callback,
 260                      void *data,
 261                      __u32 data_len,
 262                      struct lustre_handle *lockh);
 263 int ldlm_cli_callback(struct ldlm_lock *lock, struct ldlm_lock *new,
 264                       void *data, __u32 data_len, struct ptlrpc_request **reqp);
 265 int ldlm_cli_convert(struct ptlrpc_client *, struct lustre_handle *,
 266                      int new_mode, int *flags);
 267 int ldlm_cli_cancel(struct ptlrpc_client *, struct ldlm_lock *);
 268
 269 #endif /* __KERNEL__ */
 270
 271 /* ioctls for trying requests */
 272 #define IOC_LDLM_TYPE                   'f'
 273 #define IOC_LDLM_MIN_NR                 40
 274
 275 #define IOC_LDLM_TEST                   _IOWR('f', 40, long)
 276 #define IOC_LDLM_MAX_NR                 41
 277
 278 #endif