Whamcloud - gitweb
More 'rpc_register_service' removal
[fs/lustre-release.git] / 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 #include <linux/kp30.h>
9 #include <linux/list.h>
10
11 #include <linux/obd_class.h>
12
13 #ifdef __KERNEL__
14
15 #define OBD_LDLM_DEVICENAME  "ldlm"
16
17 typedef  int cluster_host;
18 typedef  int cluster_pid;
19
20 typedef enum {
21         ELDLM_OK = 0,
22         ELDLM_BLOCK_GRANTED = 600,
23         ELDLM_BLOCK_CONV,
24         ELDLM_BLOCK_WAIT,
25         ELDLM_BAD_NAMESPACE,
26         ELDLM_RES_CHANGED
27 } ldlm_error_t;
28
29 #define LDLM_FL_RES_CHANGED    (1 << 0)
30 #define LDLM_FL_COMPLETION_AST (1 << 1)
31 #define LDLM_FL_BLOCKING_AST   (1 << 2)
32
33 #define L2B(c) (1 << c)
34
35 /* compatibility matrix */
36 #define LCK_COMPAT_EX  L2B(LCK_NL)
37 #define LCK_COMPAT_PW  (LCK_COMPAT_EX | L2B(LCK_CR))
38 #define LCK_COMPAT_PR  (LCK_COMPAT_PW | L2B(LCK_PR))
39 #define LCK_COMPAT_CW  (LCK_COMPAT_PW | L2B(LCK_CW))
40 #define LCK_COMPAT_CR  (LCK_COMPAT_CW | L2B(LCK_PR) | L2B(LCK_PW))
41 #define LCK_COMPAT_NL  (LCK_COMPAT_CR | L2B(LCK_EX))
42
43 static ldlm_mode_t lck_compat_array[] = {
44         [LCK_EX] LCK_COMPAT_EX,
45         [LCK_PW] LCK_COMPAT_PW,
46         [LCK_PR] LCK_COMPAT_PR,
47         [LCK_CW] LCK_COMPAT_CW,
48         [LCK_CR] LCK_COMPAT_CR,
49         [LCK_NL] LCK_COMPAT_NL
50 };
51
52 static inline int lockmode_compat(ldlm_mode_t exist, ldlm_mode_t new)
53 {
54        if (exist < LCK_EX || exist > LCK_NL)
55               LBUG();
56        if (new < LCK_EX || new > LCK_NL)
57               LBUG();
58
59        return (lck_compat_array[exist] & L2B(new));
60 }
61
62 /* 
63  * 
64  * cluster name spaces 
65  *
66  */
67
68 #define DLM_OST_NAMESPACE 1
69 #define DLM_MDS_NAMESPACE 2
70
71 /* XXX 
72    - do we just separate this by security domains and use a prefix for 
73      multiple namespaces in the same domain? 
74    - 
75 */
76
77 struct ldlm_namespace {
78         struct list_head      ns_link;      /* in the list of ns's */
79         __u32                 ns_id;        /* identifier of ns */
80         struct list_head     *ns_hash;      /* hash table for ns */
81         struct list_head      ns_root_list; /* all root resources in ns */
82         struct obd_device    *ns_obddev;
83 };
84
85 /* 
86  * 
87  * Resource hash table 
88  *
89  */
90
91 #define RES_HASH_BITS 14
92 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
93 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
94
95 struct ldlm_lock;
96
97 typedef int (*ldlm_lock_callback)(struct ldlm_lock *lock, struct ldlm_lock *new,
98                                   void *data); 
99
100 struct ldlm_lock {
101         struct ldlm_resource *l_resource;
102         struct ldlm_lock     *l_parent;
103         struct list_head      l_children;
104         struct list_head      l_childof;
105         struct list_head      l_res_link; /*position in one of three res lists*/
106         ldlm_mode_t           l_req_mode;
107         ldlm_mode_t           l_granted_mode;
108         ldlm_lock_callback    l_completion_ast;
109         ldlm_lock_callback    l_blocking_ast;
110         struct lustre_peer   *l_peer;
111         //void                 *l_event;
112         //XXX cluster_host    l_holder;
113         __u32                 l_version[RES_VERSION_SIZE];
114 };
115
116 typedef int (*ldlm_res_compat)(struct ldlm_resource *child,
117                                struct ldlm_resource *new);
118 typedef int (*ldlm_res_policy)(struct ldlm_resource *parent, __u64 *res_id_in,
119                                __u64 *res_id_out, ldlm_mode_t mode, void *data);
120
121 #define LDLM_PLAIN       0x0
122 #define LDLM_EXTENT      0x1
123 #define LDLM_MDSINTENT   0x2
124
125 extern ldlm_res_compat ldlm_res_compat_table []; 
126 extern ldlm_res_policy ldlm_res_policy_table []; 
127
128 struct ldlm_resource {
129         struct ldlm_namespace *lr_namespace;
130         struct list_head       lr_hash;
131         struct list_head       lr_rootlink; /* link all root resources in NS */
132         struct ldlm_resource  *lr_parent;   /* 0 for a root resource */
133         struct list_head       lr_children; /* list head for child resources */
134         struct list_head       lr_childof;  /* part of child list of parent */
135
136         struct list_head       lr_granted;
137         struct list_head       lr_converting;
138         struct list_head       lr_waiting;
139         ldlm_mode_t            lr_most_restr;
140         atomic_t               lr_refcount;
141         struct ldlm_resource  *lr_root;
142         //XXX cluster_host          lr_master;
143         __u64                  lr_name[RES_NAME_SIZE];
144         __u32                  lr_version[RES_VERSION_SIZE];
145         __u32                  lr_type; /* PLAIN, EXTENT, or MDSINTENT */
146         spinlock_t             lr_lock;
147
148         void (*lr_blocking)(struct ldlm_lock *lock, struct ldlm_lock *new);
149 };
150
151 struct ldlm_extent {
152         __u64 start;
153         __u64 end;
154 };
155
156 static inline struct ldlm_extent *ldlm_res2extent(struct ldlm_resource *res)
157 {
158         return (struct ldlm_extent *)(res->lr_name);
159 }
160
161 static inline void *ldlm_handle2object(struct ldlm_handle *handle)
162 {
163         return (void *)(unsigned long)(handle->addr);
164 }
165
166 static inline void ldlm_object2handle(void *object, struct ldlm_handle *handle)
167 {
168         handle->addr = (__u64)(unsigned long)object;
169 }
170
171 static inline void ldlm_lock(struct obd_device *obddev)
172 {
173         spin_lock(&obddev->u.ldlm.ldlm_lock);
174 }
175
176 static inline void ldlm_unlock(struct obd_device *obddev)
177 {
178         spin_unlock(&obddev->u.ldlm.ldlm_lock);
179 }
180
181 extern struct obd_ops ldlm_obd_ops;
182
183 /* ldlm_extent.c */
184 int ldlm_extent_compat(struct ldlm_resource *, struct ldlm_resource *);
185 int ldlm_extent_policy(struct ldlm_resource *, __u64 *, __u64 *,
186                        ldlm_mode_t, void *);
187
188 /* ldlm_lock.c */
189 ldlm_error_t ldlm_local_lock_enqueue(struct obd_device *obddev,
190                                      __u32 ns_id,
191                                      struct ldlm_handle *parent_res_handle,
192                                      struct ldlm_handle *parent_lock_handle,
193                                      __u64 *res_id,
194                                      ldlm_mode_t mode,
195                                      int *flags,
196                                      ldlm_lock_callback completion,
197                                      ldlm_lock_callback blocking,
198                                      __u32 data_len,
199                                      void *data,
200                                      struct ldlm_handle *lockh);
201 void ldlm_lock_dump(struct ldlm_lock *lock);
202
203 /* ldlm_test.c */
204 int ldlm_test(struct obd_device *device);
205
206 /* resource.c */
207 struct ldlm_namespace *ldlm_namespace_find(struct obd_device *obddev, __u32 id);
208 struct ldlm_namespace *ldlm_namespace_new(struct obd_device *obddev, __u32 id);
209 void ldlm_resource_dump(struct ldlm_resource *res);
210 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
211                                         struct ldlm_resource *parent,
212                                         __u64 *name, int create);
213 int ldlm_resource_put(struct ldlm_resource *res);
214
215 #endif /* __KERNEL__ */
216
217 /* ioctls for trying requests */
218 #define IOC_LDLM_TYPE                   'f'
219 #define IOC_LDLM_MIN_NR                 40
220
221 #define IOC_LDLM_TEST                   _IOWR('f', 40, long)
222 #define IOC_LDLM_MAX_NR                 41
223
224 #endif