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/proc_fs.h>
  11 #include <linux/obd_class.h>
  12 #include <linux/lustre_net.h>
  13
  14 #define OBD_LDLM_DEVICENAME  "ldlm"
  15
  16 typedef enum {
  17         ELDLM_OK = 0,
  18
  19         ELDLM_LOCK_CHANGED = 300,
  20         ELDLM_LOCK_ABORTED = 301,
  21         ELDLM_RESOURCE_FREED = 302,
  22
  23         ELDLM_NAMESPACE_EXISTS = 400,
  24         ELDLM_BAD_NAMESPACE    = 401
  25 } ldlm_error_t;
  26
  27 #define LDLM_NAMESPACE_SERVER 0
  28 #define LDLM_NAMESPACE_CLIENT 1
  29
  30 #define LDLM_FL_LOCK_CHANGED   (1 << 0)
  31 #define LDLM_FL_BLOCK_GRANTED  (1 << 1)
  32 #define LDLM_FL_BLOCK_CONV     (1 << 2)
  33 #define LDLM_FL_BLOCK_WAIT     (1 << 3)
  34 #define LDLM_FL_CBPENDING      (1 << 4)
  35 #define LDLM_FL_AST_SENT       (1 << 5)
  36 #define LDLM_FL_DESTROYED      (1 << 6)
  37 #define LDLM_FL_WAIT_NOREPROC  (1 << 7)
  38
  39 #define L2B(c) (1 << c)
  40
  41 /* compatibility matrix */
  42 #define LCK_COMPAT_EX  L2B(LCK_NL)
  43 #define LCK_COMPAT_PW  (LCK_COMPAT_EX | L2B(LCK_CR))
  44 #define LCK_COMPAT_PR  (LCK_COMPAT_PW | L2B(LCK_PR))
  45 #define LCK_COMPAT_CW  (LCK_COMPAT_PW | L2B(LCK_CW))
  46 #define LCK_COMPAT_CR  (LCK_COMPAT_CW | L2B(LCK_PR) | L2B(LCK_PW))
  47 #define LCK_COMPAT_NL  (LCK_COMPAT_CR | L2B(LCK_EX))
  48
  49 static ldlm_mode_t lck_compat_array[] = {
  50         [LCK_EX] LCK_COMPAT_EX,
  51         [LCK_PW] LCK_COMPAT_PW,
  52         [LCK_PR] LCK_COMPAT_PR,
  53         [LCK_CW] LCK_COMPAT_CW,
  54         [LCK_CR] LCK_COMPAT_CR,
  55         [LCK_NL] LCK_COMPAT_NL
  56 };
  57
  58 static inline int lockmode_compat(ldlm_mode_t exist, ldlm_mode_t new)
  59 {
  60        if (exist < LCK_EX || exist > LCK_NL)
  61               LBUG();
  62        if (new < LCK_EX || new > LCK_NL)
  63               LBUG();
  64
  65        return (lck_compat_array[exist] & L2B(new));
  66 }
  67
  68 /*
  69  *
  70  * cluster name spaces
  71  *
  72  */
  73
  74 #define DLM_OST_NAMESPACE 1
  75 #define DLM_MDS_NAMESPACE 2
  76
  77 /* XXX
  78    - do we just separate this by security domains and use a prefix for
  79      multiple namespaces in the same domain?
  80    -
  81 */
  82
  83 struct ldlm_namespace {
  84         char                  *ns_name;
  85         struct ptlrpc_client   ns_rpc_client;/* used for revocation callbacks */
  86         __u32                  ns_client; /* is this a client-side lock tree? */
  87         struct list_head      *ns_hash; /* hash table for ns */
  88         __u32                  ns_refcount; /* count of resources in the hash */
  89         struct list_head       ns_root_list; /* all root resources in ns */
  90         struct lustre_lock     ns_lock; /* protects hash, refcount, list */
  91         struct list_head       ns_list_chain; /* position in global NS list */
  92         struct proc_dir_entry *ns_proc_dir;
  93 };
  94
  95 /*
  96  *
  97  * Resource hash table
  98  *
  99  */
 100
 101 #define RES_HASH_BITS 14
 102 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
 103 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
 104
 105 struct ldlm_lock;
 106
 107 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
 108                                       struct ldlm_lock_desc *new, void *data,
 109                                       __u32 data_len);
 110
 111 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags);
 112
 113 struct ldlm_lock {
 114         __u64                 l_random;
 115         int                   l_refc;
 116         struct ldlm_resource *l_resource;
 117         struct ldlm_lock     *l_parent;
 118         struct list_head      l_children;
 119         struct list_head      l_childof;
 120         struct list_head      l_res_link; /*position in one of three res lists*/
 121         struct list_head      l_inode_link; /* position in inode info list */
 122
 123         ldlm_mode_t           l_req_mode;
 124         ldlm_mode_t           l_granted_mode;
 125
 126         ldlm_completion_callback    l_completion_ast;
 127         ldlm_blocking_callback    l_blocking_ast;
 128
 129         struct ptlrpc_connection *l_connection;
 130         struct ptlrpc_client *l_client;
 131         struct lustre_handle *l_connh;
 132         __u32                 l_flags;
 133         struct lustre_handle    l_remote_handle;
 134         void                 *l_data;
 135         __u32                 l_data_len;
 136         void                 *l_cookie;
 137         int                   l_cookie_len;
 138         struct ldlm_extent    l_extent;
 139         __u32                 l_version[RES_VERSION_SIZE];
 140
 141         __u32                 l_readers;
 142         __u32                 l_writers;
 143
 144         /* If the lock is granted, a process sleeps on this waitq to learn when
 145          * it's no longer in use.  If the lock is not granted, a process sleeps
 146          * on this waitq to learn when it becomes granted. */
 147         wait_queue_head_t     l_waitq;
 148 };
 149
 150 typedef int (*ldlm_res_compat)(struct ldlm_lock *child, struct ldlm_lock *new);
 151 typedef int (*ldlm_res_policy)(struct ldlm_lock *lock, void *req_cookie,
 152                                ldlm_mode_t mode, void *data);
 153
 154 #define LDLM_PLAIN       10
 155 #define LDLM_EXTENT      11
 156 #define LDLM_MDSINTENT   12
 157
 158 #define LDLM_MIN_TYPE 10
 159 #define LDLM_MAX_TYPE 12
 160
 161 extern ldlm_res_compat ldlm_res_compat_table [];
 162 extern ldlm_res_policy ldlm_res_policy_table [];
 163
 164 struct ldlm_resource {
 165         struct ldlm_namespace *lr_namespace;
 166         struct list_head       lr_hash;
 167         struct ldlm_resource  *lr_parent;   /* 0 for a root resource */
 168         struct list_head       lr_children; /* list head for child resources */
 169         struct list_head       lr_childof;  /* part of ns_root_list if root res,
 170                                              * part of lr_children if child */
 171
 172         struct list_head       lr_granted;
 173         struct list_head       lr_converting;
 174         struct list_head       lr_waiting;
 175         ldlm_mode_t            lr_most_restr;
 176         __u32                  lr_type; /* PLAIN, EXTENT, or MDSINTENT */
 177         struct ldlm_resource  *lr_root;
 178         __u64                  lr_name[RES_NAME_SIZE];
 179         __u32                  lr_version[RES_VERSION_SIZE];
 180         atomic_t               lr_refcount;
 181         void                  *lr_tmp;
 182 };
 183
 184 struct ldlm_ast_work {
 185         struct ldlm_lock *w_lock;
 186         int               w_blocking;
 187         struct ldlm_lock_desc w_desc;
 188         struct list_head   w_list;
 189         int w_flags;
 190         void *w_data;
 191         int w_datalen;
 192 };
 193
 194 static inline struct ldlm_extent *ldlm_res2extent(struct ldlm_resource *res)
 195 {
 196         return (struct ldlm_extent *)(res->lr_name);
 197 }
 198
 199 extern struct obd_ops ldlm_obd_ops;
 200
 201
 202 extern char *ldlm_lockname[];
 203 extern char *ldlm_typename[];
 204 extern char *ldlm_it2str(int it);
 205
 206 #define LDLM_DEBUG(lock, format, a...)                                  \
 207 do {                                                                    \
 208         if (lock->l_resource == NULL)                                   \
 209                 CDEBUG(D_DLMTRACE, "### " format                        \
 210                        " (UNKNOWN: lock %p(rc=%d/%d,%d) mode %s/%s on " \
 211                        "res \?\? (rc=\?\?) type \?\?\? remote %Lx)\n" , \
 212                        ## a, lock, lock->l_refc, lock->l_readers,       \
 213                        lock->l_writers,                                 \
 214                        ldlm_lockname[lock->l_granted_mode],             \
 215                        ldlm_lockname[lock->l_req_mode],                 \
 216                        lock->l_remote_handle.addr);                     \
 217         else                                                            \
 218                 CDEBUG(D_DLMTRACE, "### " format                        \
 219                        " (%s: lock %p(rc=%d/%d,%d) mode %s/%s on res "  \
 220                        "%Lu (rc=%d) type %s remote %Lx)\n" , ## a,      \
 221                        lock->l_resource->lr_namespace->ns_name, lock,   \
 222                        lock->l_refc, lock->l_readers, lock->l_writers,  \
 223                        ldlm_lockname[lock->l_granted_mode],             \
 224                        ldlm_lockname[lock->l_req_mode],                 \
 225                        lock->l_resource->lr_name[0],                    \
 226                        atomic_read(&lock->l_resource->lr_refcount),     \
 227                        ldlm_typename[lock->l_resource->lr_type],        \
 228                        lock->l_remote_handle.addr);                     \
 229 } while (0)
 230
 231 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
 232         CDEBUG(D_DLMTRACE, "### " format "\n" , ## a)
 233
 234 /* ldlm_extent.c */
 235 int ldlm_extent_compat(struct ldlm_lock *, struct ldlm_lock *);
 236 int ldlm_extent_policy(struct ldlm_lock *, void *, ldlm_mode_t, void *);
 237
 238 /* ldlm_lockd.c */
 239 int ldlm_handle_enqueue(struct ptlrpc_request *req);
 240 int ldlm_handle_convert(struct ptlrpc_request *req);
 241 int ldlm_handle_cancel(struct ptlrpc_request *req);
 242
 243 /* ldlm_lock.c */
 244 void ldlm_register_intent(int (*arg)(struct ldlm_lock *lock, void *req_cookie,
 245                                      ldlm_mode_t mode, void *data));
 246 void ldlm_unregister_intent(void);
 247 void ldlm_lock2handle(struct ldlm_lock *lock, struct lustre_handle *lockh);
 248 struct ldlm_lock *ldlm_handle2lock(struct lustre_handle *handle);
 249 void ldlm_lock2handle(struct ldlm_lock *lock, struct lustre_handle *lockh);
 250
 251 #define LDLM_LOCK_PUT(lock)                     \
 252 do {                                            \
 253         /*LDLM_DEBUG(lock, "put");*/            \
 254         ldlm_lock_put(lock);                    \
 255 } while (0)
 256
 257 #define LDLM_LOCK_GET(lock)                     \
 258 ({                                              \
 259         ldlm_lock_get(lock);                    \
 260         /*LDLM_DEBUG(lock, "get");*/            \
 261         lock;                                   \
 262 })
 263
 264 void ldlm_lock_put(struct ldlm_lock *lock);
 265 void ldlm_lock_destroy(struct ldlm_lock *lock);
 266 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
 267 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
 268 void ldlm_lock_addref_internal(struct ldlm_lock* , __u32 mode);
 269 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
 270 void ldlm_grant_lock(struct ldlm_lock *lock);
 271 int ldlm_lock_match(struct ldlm_namespace *ns, __u64 *res_id, __u32 type,
 272                     void *cookie, int cookielen, ldlm_mode_t mode,
 273                     struct lustre_handle *lockh);
 274 struct ldlm_lock *
 275 ldlm_lock_create(struct ldlm_namespace *ns,
 276                  struct lustre_handle *parent_lock_handle,
 277                  __u64 *res_id, __u32 type, ldlm_mode_t mode, void *data,
 278                  __u32 data_len);
 279 ldlm_error_t ldlm_lock_enqueue(struct ldlm_lock *lock, void *cookie,
 280                                int cookie_len, int *flags,
 281                                ldlm_completion_callback completion,
 282                                ldlm_blocking_callback blocking);
 283 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
 284                                         int *flags);
 285 void ldlm_lock_cancel(struct ldlm_lock *lock);
 286 void ldlm_run_ast_work(struct list_head *rpc_list);
 287 void ldlm_reprocess_all(struct ldlm_resource *res);
 288 void ldlm_lock_dump(struct ldlm_lock *lock);
 289
 290 /* ldlm_test.c */
 291 int ldlm_test(struct obd_device *device, struct lustre_handle *connh);
 292 int ldlm_regression_start(struct obd_device *obddev,
 293                 struct lustre_handle *connh, int count);
 294 int ldlm_regression_stop(void);
 295
 296
 297 /* resource.c */
 298 struct ldlm_namespace *ldlm_namespace_new(char *name, __u32 local);
 299 int ldlm_namespace_free(struct ldlm_namespace *ns);
 300 int ldlm_proc_setup(struct obd_device *obd);
 301 void ldlm_proc_cleanup(struct obd_device *obd);
 302
 303 /* resource.c - internal */
 304 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
 305                                         struct ldlm_resource *parent,
 306                                         __u64 *name, __u32 type, int create);
 307 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
 308 int ldlm_resource_put(struct ldlm_resource *res);
 309 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
 310                             struct ldlm_lock *lock);
 311 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
 312 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
 313 void ldlm_dump_all_namespaces(void);
 314 void ldlm_namespace_dump(struct ldlm_namespace *);
 315 void ldlm_resource_dump(struct ldlm_resource *);
 316 int ldlm_lock_change_resource(struct ldlm_lock *, __u64 new_resid[3]);
 317
 318 /* ldlm_request.c */
 319 int ldlm_completion_ast(struct ldlm_lock *lock, int flags);
 320 int ldlm_cli_enqueue(struct lustre_handle *conn,
 321                      struct ptlrpc_request *req,
 322                      struct ldlm_namespace *ns,
 323                      struct lustre_handle *parent_lock_handle,
 324                      __u64 *res_id,
 325                      __u32 type,
 326                      void *cookie, int cookielen,
 327                      ldlm_mode_t mode,
 328                      int *flags,
 329                      ldlm_completion_callback completion,
 330                      ldlm_blocking_callback callback,
 331                      void *data,
 332                      __u32 data_len,
 333                      struct lustre_handle *lockh);
 334 int ldlm_match_or_enqueue(struct lustre_handle *connh,
 335                           struct ptlrpc_request *req,
 336                           struct ldlm_namespace *ns,
 337                           struct lustre_handle *parent_lock_handle,
 338                           __u64 *res_id,
 339                           __u32 type,
 340                           void *cookie, int cookielen,
 341                           ldlm_mode_t mode,
 342                           int *flags,
 343                           ldlm_completion_callback completion,
 344                           ldlm_blocking_callback callback,
 345                           void *data,
 346                           __u32 data_len,
 347                           struct lustre_handle *lockh);
 348 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
 349                     void *data, __u32 data_len);
 350 int ldlm_cli_convert(struct lustre_handle *, int new_mode, int *flags);
 351 int ldlm_cli_cancel(struct lustre_handle *lockh);
 352
 353 /* mds/handler.c */
 354 /* This has to be here because recurisve inclusion sucks. */
 355 int mds_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
 356                      void *data, __u32 data_len);
 357
 358 #endif /* __KERNEL__ */
 359
 360 /* ioctls for trying requests */
 361 #define IOC_LDLM_TYPE                   'f'
 362 #define IOC_LDLM_MIN_NR                 40
 363
 364 #define IOC_LDLM_TEST                   _IOWR('f', 40, long)
 365 #define IOC_LDLM_DUMP                   _IOWR('f', 41, long)
 366 #define IOC_LDLM_REGRESS_START          _IOWR('f', 42, long)
 367 #define IOC_LDLM_REGRESS_STOP           _IOWR('f', 43, long)
 368 #define IOC_LDLM_MAX_NR                 43
 369
 370 #endif