blob: 9843ee17ea2783015244a9cbfb72f0dbb2190f10 [file] [log] [blame]
Kurt Hackel6714d8e2005-12-15 14:31:23 -08001/* -*- mode: c; c-basic-offset: 8; -*-
2 * vim: noexpandtab sw=8 ts=8 sts=0:
3 *
4 * dlmcommon.h
5 *
6 * Copyright (C) 2004 Oracle. All rights reserved.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public
19 * License along with this program; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 021110-1307, USA.
22 *
23 */
24
25#ifndef DLMCOMMON_H
26#define DLMCOMMON_H
27
28#include <linux/kref.h>
29
30#define DLM_HB_NODE_DOWN_PRI (0xf000000)
31#define DLM_HB_NODE_UP_PRI (0x8000000)
32
33#define DLM_LOCKID_NAME_MAX 32
34
35#define DLM_DOMAIN_NAME_MAX_LEN 255
36#define DLM_LOCK_RES_OWNER_UNKNOWN O2NM_MAX_NODES
37#define DLM_THREAD_SHUFFLE_INTERVAL 5 // flush everything every 5 passes
38#define DLM_THREAD_MS 200 // flush at least every 200 ms
39
Joel Beckerc8f33b62006-03-16 17:40:37 -080040#define DLM_HASH_SIZE_DEFAULT (1 << 14)
41#if DLM_HASH_SIZE_DEFAULT < PAGE_SIZE
42# define DLM_HASH_PAGES 1
43#else
44# define DLM_HASH_PAGES (DLM_HASH_SIZE_DEFAULT / PAGE_SIZE)
45#endif
Daniel Phillips03d864c2006-03-10 18:08:16 -080046#define DLM_BUCKETS_PER_PAGE (PAGE_SIZE / sizeof(struct hlist_head))
47#define DLM_HASH_BUCKETS (DLM_HASH_PAGES * DLM_BUCKETS_PER_PAGE)
Kurt Hackel6714d8e2005-12-15 14:31:23 -080048
Mark Fasheha3d33292006-03-09 17:55:56 -080049/* Intended to make it easier for us to switch out hash functions */
50#define dlm_lockid_hash(_n, _l) full_name_hash(_n, _l)
51
Kurt Hackel6714d8e2005-12-15 14:31:23 -080052enum dlm_ast_type {
53 DLM_AST = 0,
54 DLM_BAST,
55 DLM_ASTUNLOCK
56};
57
58
59#define LKM_VALID_FLAGS (LKM_VALBLK | LKM_CONVERT | LKM_UNLOCK | \
60 LKM_CANCEL | LKM_INVVALBLK | LKM_FORCE | \
61 LKM_RECOVERY | LKM_LOCAL | LKM_NOQUEUE)
62
63#define DLM_RECOVERY_LOCK_NAME "$RECOVERY"
64#define DLM_RECOVERY_LOCK_NAME_LEN 9
65
66static inline int dlm_is_recovery_lock(const char *lock_name, int name_len)
67{
68 if (name_len == DLM_RECOVERY_LOCK_NAME_LEN &&
69 memcmp(lock_name, DLM_RECOVERY_LOCK_NAME, name_len)==0)
70 return 1;
71 return 0;
72}
73
Kurt Hackel466d1a42006-05-01 11:11:13 -070074#define DLM_RECO_STATE_ACTIVE 0x0001
75#define DLM_RECO_STATE_FINALIZE 0x0002
Kurt Hackel6714d8e2005-12-15 14:31:23 -080076
77struct dlm_recovery_ctxt
78{
79 struct list_head resources;
80 struct list_head received;
81 struct list_head node_data;
82 u8 new_master;
83 u8 dead_node;
84 u16 state;
85 unsigned long node_map[BITS_TO_LONGS(O2NM_MAX_NODES)];
86 wait_queue_head_t event;
87};
88
89enum dlm_ctxt_state {
90 DLM_CTXT_NEW = 0,
91 DLM_CTXT_JOINED,
92 DLM_CTXT_IN_SHUTDOWN,
93 DLM_CTXT_LEAVING,
94};
95
96struct dlm_ctxt
97{
98 struct list_head list;
Daniel Phillips03d864c2006-03-10 18:08:16 -080099 struct hlist_head **lockres_hash;
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800100 struct list_head dirty_list;
101 struct list_head purge_list;
102 struct list_head pending_asts;
103 struct list_head pending_basts;
104 unsigned int purge_count;
105 spinlock_t spinlock;
106 spinlock_t ast_lock;
107 char *name;
108 u8 node_num;
109 u32 key;
110 u8 joining_node;
111 wait_queue_head_t dlm_join_events;
112 unsigned long live_nodes_map[BITS_TO_LONGS(O2NM_MAX_NODES)];
113 unsigned long domain_map[BITS_TO_LONGS(O2NM_MAX_NODES)];
114 unsigned long recovery_map[BITS_TO_LONGS(O2NM_MAX_NODES)];
115 struct dlm_recovery_ctxt reco;
116 spinlock_t master_lock;
117 struct list_head master_list;
118 struct list_head mle_hb_events;
119
120 /* these give a really vague idea of the system load */
121 atomic_t local_resources;
122 atomic_t remote_resources;
123 atomic_t unknown_resources;
124
125 /* NOTE: Next three are protected by dlm_domain_lock */
126 struct kref dlm_refs;
127 enum dlm_ctxt_state dlm_state;
128 unsigned int num_joins;
129
130 struct o2hb_callback_func dlm_hb_up;
131 struct o2hb_callback_func dlm_hb_down;
132 struct task_struct *dlm_thread_task;
133 struct task_struct *dlm_reco_thread_task;
Kurt Hackel3156d262006-05-01 14:39:29 -0700134 struct workqueue_struct *dlm_worker;
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800135 wait_queue_head_t dlm_thread_wq;
136 wait_queue_head_t dlm_reco_thread_wq;
137 wait_queue_head_t ast_wq;
138 wait_queue_head_t migration_wq;
139
140 struct work_struct dispatched_work;
141 struct list_head work_list;
142 spinlock_t work_lock;
143 struct list_head dlm_domain_handlers;
144 struct list_head dlm_eviction_callbacks;
Joel Beckerd24fbcd2008-01-25 17:02:21 -0800145
146 /* The filesystem specifies this at domain registration. We
147 * cache it here to know what to tell other nodes. */
148 struct dlm_protocol_version fs_locking_proto;
149 /* This is the inter-dlm communication version */
150 struct dlm_protocol_version dlm_locking_proto;
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800151};
152
Daniel Phillips03d864c2006-03-10 18:08:16 -0800153static inline struct hlist_head *dlm_lockres_hash(struct dlm_ctxt *dlm, unsigned i)
154{
155 return dlm->lockres_hash[(i / DLM_BUCKETS_PER_PAGE) % DLM_HASH_PAGES] + (i % DLM_BUCKETS_PER_PAGE);
156}
157
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800158/* these keventd work queue items are for less-frequently
159 * called functions that cannot be directly called from the
160 * net message handlers for some reason, usually because
161 * they need to send net messages of their own. */
David Howellsc4028952006-11-22 14:57:56 +0000162void dlm_dispatch_work(struct work_struct *work);
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800163
164struct dlm_lock_resource;
165struct dlm_work_item;
166
167typedef void (dlm_workfunc_t)(struct dlm_work_item *, void *);
168
169struct dlm_request_all_locks_priv
170{
171 u8 reco_master;
172 u8 dead_node;
173};
174
175struct dlm_mig_lockres_priv
176{
177 struct dlm_lock_resource *lockres;
178 u8 real_master;
179};
180
181struct dlm_assert_master_priv
182{
183 struct dlm_lock_resource *lockres;
184 u8 request_from;
185 u32 flags;
186 unsigned ignore_higher:1;
187};
188
Sunil Mushranf3f85462007-01-29 15:19:16 -0800189struct dlm_deref_lockres_priv
190{
191 struct dlm_lock_resource *deref_res;
192 u8 deref_node;
193};
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800194
195struct dlm_work_item
196{
197 struct list_head list;
198 dlm_workfunc_t *func;
199 struct dlm_ctxt *dlm;
200 void *data;
201 union {
202 struct dlm_request_all_locks_priv ral;
203 struct dlm_mig_lockres_priv ml;
204 struct dlm_assert_master_priv am;
Sunil Mushranf3f85462007-01-29 15:19:16 -0800205 struct dlm_deref_lockres_priv dl;
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800206 } u;
207};
208
209static inline void dlm_init_work_item(struct dlm_ctxt *dlm,
210 struct dlm_work_item *i,
211 dlm_workfunc_t *f, void *data)
212{
213 memset(i, 0, sizeof(*i));
214 i->func = f;
215 INIT_LIST_HEAD(&i->list);
216 i->data = data;
217 i->dlm = dlm; /* must have already done a dlm_grab on this! */
218}
219
220
221
222static inline void __dlm_set_joining_node(struct dlm_ctxt *dlm,
223 u8 node)
224{
225 assert_spin_locked(&dlm->spinlock);
226
227 dlm->joining_node = node;
228 wake_up(&dlm->dlm_join_events);
229}
230
231#define DLM_LOCK_RES_UNINITED 0x00000001
232#define DLM_LOCK_RES_RECOVERING 0x00000002
233#define DLM_LOCK_RES_READY 0x00000004
234#define DLM_LOCK_RES_DIRTY 0x00000008
235#define DLM_LOCK_RES_IN_PROGRESS 0x00000010
236#define DLM_LOCK_RES_MIGRATING 0x00000020
Kurt Hackelba2bf212006-12-01 14:47:20 -0800237#define DLM_LOCK_RES_DROPPING_REF 0x00000040
Kurt Hackelddc09c82007-01-05 15:00:17 -0800238#define DLM_LOCK_RES_BLOCK_DIRTY 0x00001000
Kurt Hackel3b8118c2007-01-17 17:05:53 -0800239#define DLM_LOCK_RES_SETREF_INPROG 0x00002000
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800240
Kurt Hackel44465a72006-01-18 17:05:38 -0800241/* max milliseconds to wait to sync up a network failure with a node death */
242#define DLM_NODE_DEATH_WAIT_MAX (5 * 1000)
243
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800244#define DLM_PURGE_INTERVAL_MS (8 * 1000)
245
246struct dlm_lock_resource
247{
248 /* WARNING: Please see the comment in dlm_init_lockres before
249 * adding fields here. */
Mark Fasheh81f20942006-02-28 17:31:22 -0800250 struct hlist_node hash_node;
Mark Fasheh65c491d2006-03-06 15:36:17 -0800251 struct qstr lockname;
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800252 struct kref refs;
253
Kurt Hackel6ff06a92006-05-01 11:51:45 -0700254 /*
255 * Please keep granted, converting, and blocked in this order,
256 * as some funcs want to iterate over all lists.
257 *
258 * All four lists are protected by the hash's reference.
259 */
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800260 struct list_head granted;
261 struct list_head converting;
262 struct list_head blocked;
Kurt Hackel6ff06a92006-05-01 11:51:45 -0700263 struct list_head purge;
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800264
Kurt Hackel6ff06a92006-05-01 11:51:45 -0700265 /*
266 * These two lists require you to hold an additional reference
267 * while they are on the list.
268 */
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800269 struct list_head dirty;
270 struct list_head recovering; // dlm_recovery_ctxt.resources list
271
272 /* unused lock resources have their last_used stamped and are
273 * put on a list for the dlm thread to run. */
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800274 unsigned long last_used;
275
276 unsigned migration_pending:1;
277 atomic_t asts_reserved;
278 spinlock_t spinlock;
279 wait_queue_head_t wq;
280 u8 owner; //node which owns the lock resource, or unknown
281 u16 state;
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800282 char lvb[DLM_LVB_LEN];
Kurt Hackelba2bf212006-12-01 14:47:20 -0800283 unsigned int inflight_locks;
284 unsigned long refmap[BITS_TO_LONGS(O2NM_MAX_NODES)];
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800285};
286
287struct dlm_migratable_lock
288{
289 __be64 cookie;
290
291 /* these 3 are just padding for the in-memory structure, but
292 * list and flags are actually used when sent over the wire */
293 __be16 pad1;
294 u8 list; // 0=granted, 1=converting, 2=blocked
295 u8 flags;
296
297 s8 type;
298 s8 convert_type;
299 s8 highest_blocked;
300 u8 node;
301}; // 16 bytes
302
303struct dlm_lock
304{
305 struct dlm_migratable_lock ml;
306
307 struct list_head list;
308 struct list_head ast_list;
309 struct list_head bast_list;
310 struct dlm_lock_resource *lockres;
311 spinlock_t spinlock;
312 struct kref lock_refs;
313
314 // ast and bast must be callable while holding a spinlock!
315 dlm_astlockfunc_t *ast;
316 dlm_bastlockfunc_t *bast;
317 void *astdata;
318 struct dlm_lockstatus *lksb;
319 unsigned ast_pending:1,
320 bast_pending:1,
321 convert_pending:1,
322 lock_pending:1,
323 cancel_pending:1,
324 unlock_pending:1,
325 lksb_kernel_allocated:1;
326};
327
328
329#define DLM_LKSB_UNUSED1 0x01
330#define DLM_LKSB_PUT_LVB 0x02
331#define DLM_LKSB_GET_LVB 0x04
332#define DLM_LKSB_UNUSED2 0x08
333#define DLM_LKSB_UNUSED3 0x10
334#define DLM_LKSB_UNUSED4 0x20
335#define DLM_LKSB_UNUSED5 0x40
336#define DLM_LKSB_UNUSED6 0x80
337
338
339enum dlm_lockres_list {
340 DLM_GRANTED_LIST = 0,
341 DLM_CONVERTING_LIST,
342 DLM_BLOCKED_LIST
343};
344
Kurt Hackel8bc674c2006-04-27 18:02:10 -0700345static inline int dlm_lvb_is_empty(char *lvb)
346{
347 int i;
348 for (i=0; i<DLM_LVB_LEN; i++)
349 if (lvb[i])
350 return 0;
351 return 1;
352}
353
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800354static inline struct list_head *
355dlm_list_idx_to_ptr(struct dlm_lock_resource *res, enum dlm_lockres_list idx)
356{
357 struct list_head *ret = NULL;
358 if (idx == DLM_GRANTED_LIST)
359 ret = &res->granted;
360 else if (idx == DLM_CONVERTING_LIST)
361 ret = &res->converting;
362 else if (idx == DLM_BLOCKED_LIST)
363 ret = &res->blocked;
364 else
365 BUG();
366 return ret;
367}
368
369
370
371
372struct dlm_node_iter
373{
374 unsigned long node_map[BITS_TO_LONGS(O2NM_MAX_NODES)];
375 int curnode;
376};
377
378
379enum {
380 DLM_MASTER_REQUEST_MSG = 500,
381 DLM_UNUSED_MSG1, /* 501 */
382 DLM_ASSERT_MASTER_MSG, /* 502 */
383 DLM_CREATE_LOCK_MSG, /* 503 */
384 DLM_CONVERT_LOCK_MSG, /* 504 */
385 DLM_PROXY_AST_MSG, /* 505 */
386 DLM_UNLOCK_LOCK_MSG, /* 506 */
Kurt Hackelba2bf212006-12-01 14:47:20 -0800387 DLM_DEREF_LOCKRES_MSG, /* 507 */
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800388 DLM_MIGRATE_REQUEST_MSG, /* 508 */
389 DLM_MIG_LOCKRES_MSG, /* 509 */
390 DLM_QUERY_JOIN_MSG, /* 510 */
391 DLM_ASSERT_JOINED_MSG, /* 511 */
392 DLM_CANCEL_JOIN_MSG, /* 512 */
393 DLM_EXIT_DOMAIN_MSG, /* 513 */
394 DLM_MASTER_REQUERY_MSG, /* 514 */
395 DLM_LOCK_REQUEST_MSG, /* 515 */
396 DLM_RECO_DATA_DONE_MSG, /* 516 */
397 DLM_BEGIN_RECO_MSG, /* 517 */
398 DLM_FINALIZE_RECO_MSG /* 518 */
399};
400
401struct dlm_reco_node_data
402{
403 int state;
404 u8 node_num;
405 struct list_head list;
406};
407
408enum {
409 DLM_RECO_NODE_DATA_DEAD = -1,
410 DLM_RECO_NODE_DATA_INIT = 0,
411 DLM_RECO_NODE_DATA_REQUESTING,
412 DLM_RECO_NODE_DATA_REQUESTED,
413 DLM_RECO_NODE_DATA_RECEIVING,
414 DLM_RECO_NODE_DATA_DONE,
415 DLM_RECO_NODE_DATA_FINALIZE_SENT,
416};
417
418
419enum {
420 DLM_MASTER_RESP_NO = 0,
421 DLM_MASTER_RESP_YES,
422 DLM_MASTER_RESP_MAYBE,
423 DLM_MASTER_RESP_ERROR
424};
425
426
427struct dlm_master_request
428{
429 u8 node_idx;
430 u8 namelen;
431 __be16 pad1;
432 __be32 flags;
433
434 u8 name[O2NM_MAX_NAME_LEN];
435};
436
Kurt Hackelba2bf212006-12-01 14:47:20 -0800437#define DLM_ASSERT_RESPONSE_REASSERT 0x00000001
438#define DLM_ASSERT_RESPONSE_MASTERY_REF 0x00000002
439
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800440#define DLM_ASSERT_MASTER_MLE_CLEANUP 0x00000001
441#define DLM_ASSERT_MASTER_REQUERY 0x00000002
442#define DLM_ASSERT_MASTER_FINISH_MIGRATION 0x00000004
443struct dlm_assert_master
444{
445 u8 node_idx;
446 u8 namelen;
447 __be16 pad1;
448 __be32 flags;
449
450 u8 name[O2NM_MAX_NAME_LEN];
451};
452
Kurt Hackelba2bf212006-12-01 14:47:20 -0800453#define DLM_MIGRATE_RESPONSE_MASTERY_REF 0x00000001
454
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800455struct dlm_migrate_request
456{
457 u8 master;
458 u8 new_master;
459 u8 namelen;
460 u8 pad1;
461 __be32 pad2;
462 u8 name[O2NM_MAX_NAME_LEN];
463};
464
465struct dlm_master_requery
466{
467 u8 pad1;
468 u8 pad2;
469 u8 node_idx;
470 u8 namelen;
471 __be32 pad3;
472 u8 name[O2NM_MAX_NAME_LEN];
473};
474
475#define DLM_MRES_RECOVERY 0x01
476#define DLM_MRES_MIGRATION 0x02
477#define DLM_MRES_ALL_DONE 0x04
478
479/*
480 * We would like to get one whole lockres into a single network
481 * message whenever possible. Generally speaking, there will be
482 * at most one dlm_lock on a lockres for each node in the cluster,
483 * plus (infrequently) any additional locks coming in from userdlm.
484 *
485 * struct _dlm_lockres_page
486 * {
487 * dlm_migratable_lockres mres;
488 * dlm_migratable_lock ml[DLM_MAX_MIGRATABLE_LOCKS];
489 * u8 pad[DLM_MIG_LOCKRES_RESERVED];
490 * };
491 *
492 * from ../cluster/tcp.h
493 * NET_MAX_PAYLOAD_BYTES (4096 - sizeof(net_msg))
494 * (roughly 4080 bytes)
495 * and sizeof(dlm_migratable_lockres) = 112 bytes
496 * and sizeof(dlm_migratable_lock) = 16 bytes
497 *
498 * Choosing DLM_MAX_MIGRATABLE_LOCKS=240 and
499 * DLM_MIG_LOCKRES_RESERVED=128 means we have this:
500 *
501 * (DLM_MAX_MIGRATABLE_LOCKS * sizeof(dlm_migratable_lock)) +
502 * sizeof(dlm_migratable_lockres) + DLM_MIG_LOCKRES_RESERVED =
503 * NET_MAX_PAYLOAD_BYTES
504 * (240 * 16) + 112 + 128 = 4080
505 *
506 * So a lockres would need more than 240 locks before it would
507 * use more than one network packet to recover. Not too bad.
508 */
509#define DLM_MAX_MIGRATABLE_LOCKS 240
510
511struct dlm_migratable_lockres
512{
513 u8 master;
514 u8 lockname_len;
515 u8 num_locks; // locks sent in this structure
516 u8 flags;
517 __be32 total_locks; // locks to be sent for this migration cookie
518 __be64 mig_cookie; // cookie for this lockres migration
519 // or zero if not needed
520 // 16 bytes
521 u8 lockname[DLM_LOCKID_NAME_MAX];
522 // 48 bytes
523 u8 lvb[DLM_LVB_LEN];
524 // 112 bytes
525 struct dlm_migratable_lock ml[0]; // 16 bytes each, begins at byte 112
526};
527#define DLM_MIG_LOCKRES_MAX_LEN \
528 (sizeof(struct dlm_migratable_lockres) + \
529 (sizeof(struct dlm_migratable_lock) * \
530 DLM_MAX_MIGRATABLE_LOCKS) )
531
532/* from above, 128 bytes
533 * for some undetermined future use */
534#define DLM_MIG_LOCKRES_RESERVED (NET_MAX_PAYLOAD_BYTES - \
535 DLM_MIG_LOCKRES_MAX_LEN)
536
537struct dlm_create_lock
538{
539 __be64 cookie;
540
541 __be32 flags;
542 u8 pad1;
543 u8 node_idx;
544 s8 requested_type;
545 u8 namelen;
546
547 u8 name[O2NM_MAX_NAME_LEN];
548};
549
550struct dlm_convert_lock
551{
552 __be64 cookie;
553
554 __be32 flags;
555 u8 pad1;
556 u8 node_idx;
557 s8 requested_type;
558 u8 namelen;
559
560 u8 name[O2NM_MAX_NAME_LEN];
561
562 s8 lvb[0];
563};
564#define DLM_CONVERT_LOCK_MAX_LEN (sizeof(struct dlm_convert_lock)+DLM_LVB_LEN)
565
566struct dlm_unlock_lock
567{
568 __be64 cookie;
569
570 __be32 flags;
571 __be16 pad1;
572 u8 node_idx;
573 u8 namelen;
574
575 u8 name[O2NM_MAX_NAME_LEN];
576
577 s8 lvb[0];
578};
579#define DLM_UNLOCK_LOCK_MAX_LEN (sizeof(struct dlm_unlock_lock)+DLM_LVB_LEN)
580
581struct dlm_proxy_ast
582{
583 __be64 cookie;
584
585 __be32 flags;
586 u8 node_idx;
587 u8 type;
588 u8 blocked_type;
589 u8 namelen;
590
591 u8 name[O2NM_MAX_NAME_LEN];
592
593 s8 lvb[0];
594};
595#define DLM_PROXY_AST_MAX_LEN (sizeof(struct dlm_proxy_ast)+DLM_LVB_LEN)
596
597#define DLM_MOD_KEY (0x666c6172)
Joel Beckerd24fbcd2008-01-25 17:02:21 -0800598enum dlm_query_join_response_code {
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800599 JOIN_DISALLOW = 0,
600 JOIN_OK,
601 JOIN_OK_NO_MAP,
Joel Beckerd24fbcd2008-01-25 17:02:21 -0800602 JOIN_PROTOCOL_MISMATCH,
603};
604
605union dlm_query_join_response {
606 u32 intval;
607 struct {
608 u8 code; /* Response code. dlm_minor and fs_minor
609 are only valid if this is JOIN_OK */
610 u8 dlm_minor; /* The minor version of the protocol the
611 dlm is speaking. */
612 u8 fs_minor; /* The minor version of the protocol the
613 filesystem is speaking. */
614 u8 reserved;
615 } packet;
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800616};
617
618struct dlm_lock_request
619{
620 u8 node_idx;
621 u8 dead_node;
622 __be16 pad1;
623 __be32 pad2;
624};
625
626struct dlm_reco_data_done
627{
628 u8 node_idx;
629 u8 dead_node;
630 __be16 pad1;
631 __be32 pad2;
632
633 /* unused for now */
634 /* eventually we can use this to attempt
635 * lvb recovery based on each node's info */
636 u8 reco_lvb[DLM_LVB_LEN];
637};
638
639struct dlm_begin_reco
640{
641 u8 node_idx;
642 u8 dead_node;
643 __be16 pad1;
644 __be32 pad2;
645};
646
647
Srinivas Eeda1faf2892007-01-29 15:31:35 -0800648#define BITS_PER_BYTE 8
649#define BITS_TO_BYTES(bits) (((bits)+BITS_PER_BYTE-1)/BITS_PER_BYTE)
650
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800651struct dlm_query_join_request
652{
653 u8 node_idx;
654 u8 pad1[2];
655 u8 name_len;
Joel Beckerd24fbcd2008-01-25 17:02:21 -0800656 struct dlm_protocol_version dlm_proto;
657 struct dlm_protocol_version fs_proto;
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800658 u8 domain[O2NM_MAX_NAME_LEN];
Srinivas Eeda1faf2892007-01-29 15:31:35 -0800659 u8 node_map[BITS_TO_BYTES(O2NM_MAX_NODES)];
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800660};
661
662struct dlm_assert_joined
663{
664 u8 node_idx;
665 u8 pad1[2];
666 u8 name_len;
667 u8 domain[O2NM_MAX_NAME_LEN];
668};
669
670struct dlm_cancel_join
671{
672 u8 node_idx;
673 u8 pad1[2];
674 u8 name_len;
675 u8 domain[O2NM_MAX_NAME_LEN];
676};
677
678struct dlm_exit_domain
679{
680 u8 node_idx;
681 u8 pad1[3];
682};
683
684struct dlm_finalize_reco
685{
686 u8 node_idx;
687 u8 dead_node;
Kurt Hackel466d1a42006-05-01 11:11:13 -0700688 u8 flags;
689 u8 pad1;
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800690 __be32 pad2;
691};
692
Kurt Hackelba2bf212006-12-01 14:47:20 -0800693struct dlm_deref_lockres
694{
695 u32 pad1;
696 u16 pad2;
697 u8 node_idx;
698 u8 namelen;
699
700 u8 name[O2NM_MAX_NAME_LEN];
701};
702
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800703static inline enum dlm_status
704__dlm_lockres_state_to_status(struct dlm_lock_resource *res)
705{
706 enum dlm_status status = DLM_NORMAL;
707
708 assert_spin_locked(&res->spinlock);
709
710 if (res->state & DLM_LOCK_RES_RECOVERING)
711 status = DLM_RECOVERING;
712 else if (res->state & DLM_LOCK_RES_MIGRATING)
713 status = DLM_MIGRATING;
714 else if (res->state & DLM_LOCK_RES_IN_PROGRESS)
715 status = DLM_FORWARD;
716
717 return status;
718}
719
Kurt Hackel29004852006-03-02 16:43:36 -0800720static inline u8 dlm_get_lock_cookie_node(u64 cookie)
721{
722 u8 ret;
723 cookie >>= 56;
724 ret = (u8)(cookie & 0xffULL);
725 return ret;
726}
727
728static inline unsigned long long dlm_get_lock_cookie_seq(u64 cookie)
729{
730 unsigned long long ret;
731 ret = ((unsigned long long)cookie) & 0x00ffffffffffffffULL;
732 return ret;
733}
734
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800735struct dlm_lock * dlm_new_lock(int type, u8 node, u64 cookie,
736 struct dlm_lockstatus *lksb);
737void dlm_lock_get(struct dlm_lock *lock);
738void dlm_lock_put(struct dlm_lock *lock);
739
740void dlm_lock_attach_lockres(struct dlm_lock *lock,
741 struct dlm_lock_resource *res);
742
Kurt Hackeld74c9802007-01-17 17:04:25 -0800743int dlm_create_lock_handler(struct o2net_msg *msg, u32 len, void *data,
744 void **ret_data);
745int dlm_convert_lock_handler(struct o2net_msg *msg, u32 len, void *data,
746 void **ret_data);
747int dlm_proxy_ast_handler(struct o2net_msg *msg, u32 len, void *data,
748 void **ret_data);
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800749
750void dlm_revert_pending_convert(struct dlm_lock_resource *res,
751 struct dlm_lock *lock);
752void dlm_revert_pending_lock(struct dlm_lock_resource *res,
753 struct dlm_lock *lock);
754
Kurt Hackeld74c9802007-01-17 17:04:25 -0800755int dlm_unlock_lock_handler(struct o2net_msg *msg, u32 len, void *data,
756 void **ret_data);
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800757void dlm_commit_pending_cancel(struct dlm_lock_resource *res,
758 struct dlm_lock *lock);
759void dlm_commit_pending_unlock(struct dlm_lock_resource *res,
760 struct dlm_lock *lock);
761
762int dlm_launch_thread(struct dlm_ctxt *dlm);
763void dlm_complete_thread(struct dlm_ctxt *dlm);
764int dlm_launch_recovery_thread(struct dlm_ctxt *dlm);
765void dlm_complete_recovery_thread(struct dlm_ctxt *dlm);
766void dlm_wait_for_recovery(struct dlm_ctxt *dlm);
Kurt Hackelc03872f2006-03-06 14:08:49 -0800767void dlm_kick_recovery_thread(struct dlm_ctxt *dlm);
Kurt Hackele2faea42006-01-12 14:24:55 -0800768int dlm_is_node_dead(struct dlm_ctxt *dlm, u8 node);
Kurt Hackel44465a72006-01-18 17:05:38 -0800769int dlm_wait_for_node_death(struct dlm_ctxt *dlm, u8 node, int timeout);
Kurt Hackelb7084ab2006-05-01 13:54:07 -0700770int dlm_wait_for_node_recovery(struct dlm_ctxt *dlm, u8 node, int timeout);
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800771
772void dlm_put(struct dlm_ctxt *dlm);
773struct dlm_ctxt *dlm_grab(struct dlm_ctxt *dlm);
774int dlm_domain_fully_joined(struct dlm_ctxt *dlm);
775
776void __dlm_lockres_calc_usage(struct dlm_ctxt *dlm,
777 struct dlm_lock_resource *res);
778void dlm_lockres_calc_usage(struct dlm_ctxt *dlm,
779 struct dlm_lock_resource *res);
Mark Fasheh95c4f582006-03-10 13:44:00 -0800780static inline void dlm_lockres_get(struct dlm_lock_resource *res)
781{
782 /* This is called on every lookup, so it might be worth
783 * inlining. */
784 kref_get(&res->refs);
785}
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800786void dlm_lockres_put(struct dlm_lock_resource *res);
787void __dlm_unhash_lockres(struct dlm_lock_resource *res);
788void __dlm_insert_lockres(struct dlm_ctxt *dlm,
789 struct dlm_lock_resource *res);
Kurt Hackelba2bf212006-12-01 14:47:20 -0800790struct dlm_lock_resource * __dlm_lookup_lockres_full(struct dlm_ctxt *dlm,
791 const char *name,
792 unsigned int len,
793 unsigned int hash);
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800794struct dlm_lock_resource * __dlm_lookup_lockres(struct dlm_ctxt *dlm,
795 const char *name,
Mark Fasheha3d33292006-03-09 17:55:56 -0800796 unsigned int len,
797 unsigned int hash);
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800798struct dlm_lock_resource * dlm_lookup_lockres(struct dlm_ctxt *dlm,
799 const char *name,
800 unsigned int len);
801
802int dlm_is_host_down(int errno);
803void dlm_change_lockres_owner(struct dlm_ctxt *dlm,
804 struct dlm_lock_resource *res,
805 u8 owner);
806struct dlm_lock_resource * dlm_get_lock_resource(struct dlm_ctxt *dlm,
807 const char *lockid,
Mark Fasheh3384f3d2006-09-08 11:38:29 -0700808 int namelen,
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800809 int flags);
810struct dlm_lock_resource *dlm_new_lockres(struct dlm_ctxt *dlm,
811 const char *name,
812 unsigned int namelen);
813
Kurt Hackelba2bf212006-12-01 14:47:20 -0800814#define dlm_lockres_set_refmap_bit(bit,res) \
815 __dlm_lockres_set_refmap_bit(bit,res,__FILE__,__LINE__)
816#define dlm_lockres_clear_refmap_bit(bit,res) \
817 __dlm_lockres_clear_refmap_bit(bit,res,__FILE__,__LINE__)
818
819static inline void __dlm_lockres_set_refmap_bit(int bit,
820 struct dlm_lock_resource *res,
821 const char *file,
822 int line)
823{
824 //printk("%s:%d:%.*s: setting bit %d\n", file, line,
825 // res->lockname.len, res->lockname.name, bit);
826 set_bit(bit, res->refmap);
827}
828
829static inline void __dlm_lockres_clear_refmap_bit(int bit,
830 struct dlm_lock_resource *res,
831 const char *file,
832 int line)
833{
834 //printk("%s:%d:%.*s: clearing bit %d\n", file, line,
835 // res->lockname.len, res->lockname.name, bit);
836 clear_bit(bit, res->refmap);
837}
838
839void __dlm_lockres_drop_inflight_ref(struct dlm_ctxt *dlm,
840 struct dlm_lock_resource *res,
841 const char *file,
842 int line);
843void __dlm_lockres_grab_inflight_ref(struct dlm_ctxt *dlm,
844 struct dlm_lock_resource *res,
845 int new_lockres,
846 const char *file,
847 int line);
848#define dlm_lockres_drop_inflight_ref(d,r) \
849 __dlm_lockres_drop_inflight_ref(d,r,__FILE__,__LINE__)
850#define dlm_lockres_grab_inflight_ref(d,r) \
851 __dlm_lockres_grab_inflight_ref(d,r,0,__FILE__,__LINE__)
852#define dlm_lockres_grab_inflight_ref_new(d,r) \
853 __dlm_lockres_grab_inflight_ref(d,r,1,__FILE__,__LINE__)
854
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800855void dlm_queue_ast(struct dlm_ctxt *dlm, struct dlm_lock *lock);
856void dlm_queue_bast(struct dlm_ctxt *dlm, struct dlm_lock *lock);
857void dlm_do_local_ast(struct dlm_ctxt *dlm,
858 struct dlm_lock_resource *res,
859 struct dlm_lock *lock);
860int dlm_do_remote_ast(struct dlm_ctxt *dlm,
861 struct dlm_lock_resource *res,
862 struct dlm_lock *lock);
863void dlm_do_local_bast(struct dlm_ctxt *dlm,
864 struct dlm_lock_resource *res,
865 struct dlm_lock *lock,
866 int blocked_type);
867int dlm_send_proxy_ast_msg(struct dlm_ctxt *dlm,
868 struct dlm_lock_resource *res,
869 struct dlm_lock *lock,
870 int msg_type,
871 int blocked_type, int flags);
872static inline int dlm_send_proxy_bast(struct dlm_ctxt *dlm,
873 struct dlm_lock_resource *res,
874 struct dlm_lock *lock,
875 int blocked_type)
876{
877 return dlm_send_proxy_ast_msg(dlm, res, lock, DLM_BAST,
878 blocked_type, 0);
879}
880
881static inline int dlm_send_proxy_ast(struct dlm_ctxt *dlm,
882 struct dlm_lock_resource *res,
883 struct dlm_lock *lock,
884 int flags)
885{
886 return dlm_send_proxy_ast_msg(dlm, res, lock, DLM_AST,
887 0, flags);
888}
889
890void dlm_print_one_lock_resource(struct dlm_lock_resource *res);
891void __dlm_print_one_lock_resource(struct dlm_lock_resource *res);
892
893u8 dlm_nm_this_node(struct dlm_ctxt *dlm);
894void dlm_kick_thread(struct dlm_ctxt *dlm, struct dlm_lock_resource *res);
895void __dlm_dirty_lockres(struct dlm_ctxt *dlm, struct dlm_lock_resource *res);
896
897
898int dlm_nm_init(struct dlm_ctxt *dlm);
899int dlm_heartbeat_init(struct dlm_ctxt *dlm);
900void dlm_hb_node_down_cb(struct o2nm_node *node, int idx, void *data);
901void dlm_hb_node_up_cb(struct o2nm_node *node, int idx, void *data);
902
Kurt Hackelba2bf212006-12-01 14:47:20 -0800903int dlm_empty_lockres(struct dlm_ctxt *dlm, struct dlm_lock_resource *res);
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800904int dlm_finish_migration(struct dlm_ctxt *dlm,
905 struct dlm_lock_resource *res,
906 u8 old_master);
907void dlm_lockres_release_ast(struct dlm_ctxt *dlm,
908 struct dlm_lock_resource *res);
909void __dlm_lockres_reserve_ast(struct dlm_lock_resource *res);
910
Kurt Hackeld74c9802007-01-17 17:04:25 -0800911int dlm_master_request_handler(struct o2net_msg *msg, u32 len, void *data,
912 void **ret_data);
913int dlm_assert_master_handler(struct o2net_msg *msg, u32 len, void *data,
914 void **ret_data);
Kurt Hackel3b8118c2007-01-17 17:05:53 -0800915void dlm_assert_master_post_handler(int status, void *data, void *ret_data);
Kurt Hackeld74c9802007-01-17 17:04:25 -0800916int dlm_deref_lockres_handler(struct o2net_msg *msg, u32 len, void *data,
917 void **ret_data);
918int dlm_migrate_request_handler(struct o2net_msg *msg, u32 len, void *data,
919 void **ret_data);
920int dlm_mig_lockres_handler(struct o2net_msg *msg, u32 len, void *data,
921 void **ret_data);
922int dlm_master_requery_handler(struct o2net_msg *msg, u32 len, void *data,
923 void **ret_data);
924int dlm_request_all_locks_handler(struct o2net_msg *msg, u32 len, void *data,
925 void **ret_data);
926int dlm_reco_data_done_handler(struct o2net_msg *msg, u32 len, void *data,
927 void **ret_data);
928int dlm_begin_reco_handler(struct o2net_msg *msg, u32 len, void *data,
929 void **ret_data);
930int dlm_finalize_reco_handler(struct o2net_msg *msg, u32 len, void *data,
931 void **ret_data);
Kurt Hackelc03872f2006-03-06 14:08:49 -0800932int dlm_do_master_requery(struct dlm_ctxt *dlm, struct dlm_lock_resource *res,
933 u8 nodenum, u8 *real_master);
Kurt Hackelc03872f2006-03-06 14:08:49 -0800934
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800935
936int dlm_dispatch_assert_master(struct dlm_ctxt *dlm,
937 struct dlm_lock_resource *res,
938 int ignore_higher,
939 u8 request_from,
940 u32 flags);
941
942
943int dlm_send_one_lockres(struct dlm_ctxt *dlm,
944 struct dlm_lock_resource *res,
945 struct dlm_migratable_lockres *mres,
946 u8 send_to,
947 u8 flags);
948void dlm_move_lockres_to_recovery_list(struct dlm_ctxt *dlm,
949 struct dlm_lock_resource *res);
950
951/* will exit holding res->spinlock, but may drop in function */
952void __dlm_wait_on_lockres_flags(struct dlm_lock_resource *res, int flags);
953void __dlm_wait_on_lockres_flags_set(struct dlm_lock_resource *res, int flags);
954
955/* will exit holding res->spinlock, but may drop in function */
956static inline void __dlm_wait_on_lockres(struct dlm_lock_resource *res)
957{
958 __dlm_wait_on_lockres_flags(res, (DLM_LOCK_RES_IN_PROGRESS|
959 DLM_LOCK_RES_RECOVERING|
960 DLM_LOCK_RES_MIGRATING));
961}
962
963
964int dlm_init_mle_cache(void);
965void dlm_destroy_mle_cache(void);
966void dlm_hb_event_notify_attached(struct dlm_ctxt *dlm, int idx, int node_up);
Kurt Hackelba2bf212006-12-01 14:47:20 -0800967int dlm_drop_lockres_ref(struct dlm_ctxt *dlm,
968 struct dlm_lock_resource *res);
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800969void dlm_clean_master_list(struct dlm_ctxt *dlm,
970 u8 dead_node);
971int dlm_lock_basts_flushed(struct dlm_ctxt *dlm, struct dlm_lock *lock);
Kurt Hackelba2bf212006-12-01 14:47:20 -0800972int __dlm_lockres_has_locks(struct dlm_lock_resource *res);
Kurt Hackel69d72b02006-05-01 10:57:51 -0700973int __dlm_lockres_unused(struct dlm_lock_resource *res);
Kurt Hackel6714d8e2005-12-15 14:31:23 -0800974
975static inline const char * dlm_lock_mode_name(int mode)
976{
977 switch (mode) {
978 case LKM_EXMODE:
979 return "EX";
980 case LKM_PRMODE:
981 return "PR";
982 case LKM_NLMODE:
983 return "NL";
984 }
985 return "UNKNOWN";
986}
987
988
989static inline int dlm_lock_compatible(int existing, int request)
990{
991 /* NO_LOCK compatible with all */
992 if (request == LKM_NLMODE ||
993 existing == LKM_NLMODE)
994 return 1;
995
996 /* EX incompatible with all non-NO_LOCK */
997 if (request == LKM_EXMODE)
998 return 0;
999
1000 /* request must be PR, which is compatible with PR */
1001 if (existing == LKM_PRMODE)
1002 return 1;
1003
1004 return 0;
1005}
1006
1007static inline int dlm_lock_on_list(struct list_head *head,
1008 struct dlm_lock *lock)
1009{
1010 struct list_head *iter;
1011 struct dlm_lock *tmplock;
1012
1013 list_for_each(iter, head) {
1014 tmplock = list_entry(iter, struct dlm_lock, list);
1015 if (tmplock == lock)
1016 return 1;
1017 }
1018 return 0;
1019}
1020
1021
1022static inline enum dlm_status dlm_err_to_dlm_status(int err)
1023{
1024 enum dlm_status ret;
1025 if (err == -ENOMEM)
1026 ret = DLM_SYSERR;
1027 else if (err == -ETIMEDOUT || o2net_link_down(err, NULL))
1028 ret = DLM_NOLOCKMGR;
1029 else if (err == -EINVAL)
1030 ret = DLM_BADPARAM;
1031 else if (err == -ENAMETOOLONG)
1032 ret = DLM_IVBUFLEN;
1033 else
1034 ret = DLM_BADARGS;
1035 return ret;
1036}
1037
1038
1039static inline void dlm_node_iter_init(unsigned long *map,
1040 struct dlm_node_iter *iter)
1041{
1042 memcpy(iter->node_map, map, sizeof(iter->node_map));
1043 iter->curnode = -1;
1044}
1045
1046static inline int dlm_node_iter_next(struct dlm_node_iter *iter)
1047{
1048 int bit;
1049 bit = find_next_bit(iter->node_map, O2NM_MAX_NODES, iter->curnode+1);
1050 if (bit >= O2NM_MAX_NODES) {
1051 iter->curnode = O2NM_MAX_NODES;
1052 return -ENOENT;
1053 }
1054 iter->curnode = bit;
1055 return bit;
1056}
1057
1058
1059
1060#endif /* DLMCOMMON_H */