blob: 04fe9f525ac78aa1fe26a8210c59b5850618a6fe [file] [log] [blame]
Thomas Gleixner2522fe42019-05-28 09:57:20 -07001/* SPDX-License-Identifier: GPL-2.0-only */
David Teiglande7fd4172006-01-18 09:30:29 +00002/******************************************************************************
3*******************************************************************************
4**
5** Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
David Teigland60f98d12011-11-02 14:30:58 -05006** Copyright (C) 2004-2011 Red Hat, Inc. All rights reserved.
David Teiglande7fd4172006-01-18 09:30:29 +00007**
David Teiglande7fd4172006-01-18 09:30:29 +00008**
9*******************************************************************************
10******************************************************************************/
11
12#ifndef __DLM_INTERNAL_DOT_H__
13#define __DLM_INTERNAL_DOT_H__
14
15/*
16 * This is the main header file to be included in each DLM source file.
17 */
18
David Teiglande7fd4172006-01-18 09:30:29 +000019#include <linux/slab.h>
20#include <linux/sched.h>
21#include <linux/types.h>
22#include <linux/ctype.h>
23#include <linux/spinlock.h>
24#include <linux/vmalloc.h>
25#include <linux/list.h>
26#include <linux/errno.h>
27#include <linux/random.h>
28#include <linux/delay.h>
29#include <linux/socket.h>
30#include <linux/kthread.h>
31#include <linux/kobject.h>
32#include <linux/kref.h>
33#include <linux/kernel.h>
34#include <linux/jhash.h>
David Teigland597d0ca2006-07-12 16:44:04 -050035#include <linux/miscdevice.h>
David Teigland90135922006-01-20 08:47:07 +000036#include <linux/mutex.h>
David Teigland3d6aa672011-07-06 17:00:54 -050037#include <linux/idr.h>
David Teiglandd6e24782012-04-23 13:58:42 -050038#include <linux/ratelimit.h>
Linus Torvalds7c0f6ba2016-12-24 11:46:01 -080039#include <linux/uaccess.h>
David Teiglande7fd4172006-01-18 09:30:29 +000040
41#include <linux/dlm.h>
David Teigland99fc6482007-01-09 09:44:01 -060042#include "config.h"
David Teiglande7fd4172006-01-18 09:30:29 +000043
David Teiglande7fd4172006-01-18 09:30:29 +000044/* Size of the temp buffer midcomms allocates on the stack.
45 We try to make this large enough so most messages fit.
46 FIXME: should sctp make this unnecessary? */
47
48#define DLM_INBUF_LEN 148
49
50struct dlm_ls;
51struct dlm_lkb;
52struct dlm_rsb;
53struct dlm_member;
David Teiglande7fd4172006-01-18 09:30:29 +000054struct dlm_rsbtable;
David Teiglande7fd4172006-01-18 09:30:29 +000055struct dlm_recover;
56struct dlm_header;
57struct dlm_message;
58struct dlm_rcom;
59struct dlm_mhandle;
60
61#define log_print(fmt, args...) \
62 printk(KERN_ERR "dlm: "fmt"\n" , ##args)
63#define log_error(ls, fmt, args...) \
64 printk(KERN_ERR "dlm: %s: " fmt "\n", (ls)->ls_name , ##args)
Zhilong Liu505ee522016-06-19 23:52:46 -050065
David Teigland075f0172014-02-14 11:54:44 -060066#define log_rinfo(ls, fmt, args...) \
Zhilong Liu505ee522016-06-19 23:52:46 -050067do { \
68 if (dlm_config.ci_log_info) \
69 printk(KERN_INFO "dlm: %s: " fmt "\n", \
70 (ls)->ls_name, ##args); \
71 else if (dlm_config.ci_log_debug) \
72 printk(KERN_DEBUG "dlm: %s: " fmt "\n", \
73 (ls)->ls_name , ##args); \
74} while (0)
David Teiglande7fd4172006-01-18 09:30:29 +000075
David Teigland99fc6482007-01-09 09:44:01 -060076#define log_debug(ls, fmt, args...) \
77do { \
78 if (dlm_config.ci_log_debug) \
79 printk(KERN_DEBUG "dlm: %s: " fmt "\n", \
80 (ls)->ls_name , ##args); \
81} while (0)
David Teiglande7fd4172006-01-18 09:30:29 +000082
David Teiglandd6e24782012-04-23 13:58:42 -050083#define log_limit(ls, fmt, args...) \
84do { \
85 if (dlm_config.ci_log_debug) \
86 printk_ratelimited(KERN_DEBUG "dlm: %s: " fmt "\n", \
87 (ls)->ls_name , ##args); \
88} while (0)
89
David Teiglande7fd4172006-01-18 09:30:29 +000090#define DLM_ASSERT(x, do) \
91{ \
92 if (!(x)) \
93 { \
94 printk(KERN_ERR "\nDLM: Assertion failed on line %d of file %s\n" \
95 "DLM: assertion: \"%s\"\n" \
96 "DLM: time = %lu\n", \
97 __LINE__, __FILE__, #x, jiffies); \
98 {do} \
99 printk("\n"); \
David Teiglande7fd4172006-01-18 09:30:29 +0000100 panic("DLM: Record message above and reboot.\n"); \
101 } \
102}
103
104
David Teiglandf1172282013-01-07 11:03:42 -0600105#define DLM_RTF_SHRINK 0x00000001
106
David Teiglande7fd4172006-01-18 09:30:29 +0000107struct dlm_rsbtable {
Bob Peterson9beb3bf2011-10-26 15:24:55 -0500108 struct rb_root keep;
109 struct rb_root toss;
David Teiglandc7be7612009-01-07 16:50:41 -0600110 spinlock_t lock;
David Teiglandf1172282013-01-07 11:03:42 -0600111 uint32_t flags;
David Teiglande7fd4172006-01-18 09:30:29 +0000112};
113
David Teiglande7fd4172006-01-18 09:30:29 +0000114
115/*
116 * Lockspace member (per node in a ls)
117 */
118
119struct dlm_member {
120 struct list_head list;
121 int nodeid;
122 int weight;
David Teigland757a4272011-10-20 13:26:28 -0500123 int slot;
124 int slot_prev;
David Teigland60f98d12011-11-02 14:30:58 -0500125 int comm_seq;
David Teigland757a4272011-10-20 13:26:28 -0500126 uint32_t generation;
127};
128
129/*
David Teiglande7fd4172006-01-18 09:30:29 +0000130 * Save and manage recovery state for a lockspace.
131 */
132
133struct dlm_recover {
134 struct list_head list;
David Teigland60f98d12011-11-02 14:30:58 -0500135 struct dlm_config_node *nodes;
136 int nodes_count;
David Teiglande7fd4172006-01-18 09:30:29 +0000137 uint64_t seq;
138};
139
140/*
141 * Pass input args to second stage locking function.
142 */
143
144struct dlm_args {
145 uint32_t flags;
David Teiglande5dae542008-02-06 00:35:45 -0600146 void (*astfn) (void *astparam);
147 void *astparam;
148 void (*bastfn) (void *astparam, int mode);
David Teiglande7fd4172006-01-18 09:30:29 +0000149 int mode;
150 struct dlm_lksb *lksb;
David Teiglandd7db9232007-05-18 09:00:32 -0500151 unsigned long timeout;
David Teiglande7fd4172006-01-18 09:30:29 +0000152};
153
154
155/*
156 * Lock block
157 *
158 * A lock can be one of three types:
159 *
160 * local copy lock is mastered locally
161 * (lkb_nodeid is zero and DLM_LKF_MSTCPY is not set)
162 * process copy lock is mastered on a remote node
163 * (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is not set)
164 * master copy master node's copy of a lock owned by remote node
165 * (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is set)
166 *
167 * lkb_exflags: a copy of the most recent flags arg provided to dlm_lock or
168 * dlm_unlock. The dlm does not modify these or use any private flags in
169 * this field; it only contains DLM_LKF_ flags from dlm.h. These flags
170 * are sent as-is to the remote master when the lock is remote.
171 *
172 * lkb_flags: internal dlm flags (DLM_IFL_ prefix) from dlm_internal.h.
173 * Some internal flags are shared between the master and process nodes;
174 * these shared flags are kept in the lower two bytes. One of these
175 * flags set on the master copy will be propagated to the process copy
176 * and v.v. Other internal flags are private to the master or process
177 * node (e.g. DLM_IFL_MSTCPY). These are kept in the high two bytes.
178 *
179 * lkb_sbflags: status block flags. These flags are copied directly into
180 * the caller's lksb.sb_flags prior to the dlm_lock/dlm_unlock completion
181 * ast. All defined in dlm.h with DLM_SBF_ prefix.
182 *
183 * lkb_status: the lock status indicates which rsb queue the lock is
184 * on, grant, convert, or wait. DLM_LKSTS_ WAITING/GRANTED/CONVERT
185 *
186 * lkb_wait_type: the dlm message type (DLM_MSG_ prefix) for which a
187 * reply is needed. Only set when the lkb is on the lockspace waiters
188 * list awaiting a reply from a remote node.
189 *
190 * lkb_nodeid: when the lkb is a local copy, nodeid is 0; when the lkb
191 * is a master copy, nodeid specifies the remote lock holder, when the
192 * lkb is a process copy, the nodeid specifies the lock master.
193 */
194
David Teiglande7fd4172006-01-18 09:30:29 +0000195/* lkb_status */
196
197#define DLM_LKSTS_WAITING 1
198#define DLM_LKSTS_GRANTED 2
199#define DLM_LKSTS_CONVERT 3
200
201/* lkb_flags */
202
203#define DLM_IFL_MSTCPY 0x00010000
204#define DLM_IFL_RESEND 0x00020000
David Teigland597d0ca2006-07-12 16:44:04 -0500205#define DLM_IFL_DEAD 0x00040000
David Teiglandef0c2bb2007-03-28 09:56:46 -0500206#define DLM_IFL_OVERLAP_UNLOCK 0x00080000
207#define DLM_IFL_OVERLAP_CANCEL 0x00100000
208#define DLM_IFL_ENDOFLIFE 0x00200000
David Teigland3ae1acf2007-05-18 08:59:31 -0500209#define DLM_IFL_WATCH_TIMEWARN 0x00400000
David Teigland84d8cd62007-05-29 08:44:23 -0500210#define DLM_IFL_TIMEOUT_CANCEL 0x00800000
David Teigland8b4021f2007-05-29 08:46:00 -0500211#define DLM_IFL_DEADLOCK_CANCEL 0x01000000
David Teigland2a7ce0e2011-04-04 15:19:59 -0500212#define DLM_IFL_STUB_MS 0x02000000 /* magic number for m_flags */
David Teigland597d0ca2006-07-12 16:44:04 -0500213#define DLM_IFL_USER 0x00000001
214#define DLM_IFL_ORPHAN 0x00000002
David Teiglande7fd4172006-01-18 09:30:29 +0000215
David Teigland8304d6f2011-02-21 14:58:21 -0600216#define DLM_CALLBACKS_SIZE 6
217
218#define DLM_CB_CAST 0x00000001
219#define DLM_CB_BAST 0x00000002
220#define DLM_CB_SKIP 0x00000004
221
222struct dlm_callback {
223 uint64_t seq;
224 uint32_t flags; /* DLM_CBF_ */
225 int sb_status; /* copy to lksb status */
226 uint8_t sb_flags; /* copy to lksb flags */
227 int8_t mode; /* rq mode of bast, gr mode of cast */
228};
229
David Teiglande7fd4172006-01-18 09:30:29 +0000230struct dlm_lkb {
231 struct dlm_rsb *lkb_resource; /* the rsb */
232 struct kref lkb_ref;
233 int lkb_nodeid; /* copied from rsb */
234 int lkb_ownpid; /* pid of lock owner */
235 uint32_t lkb_id; /* our lock ID */
236 uint32_t lkb_remid; /* lock ID on remote partner */
237 uint32_t lkb_exflags; /* external flags from caller */
238 uint32_t lkb_sbflags; /* lksb flags */
239 uint32_t lkb_flags; /* internal flags */
240 uint32_t lkb_lvbseq; /* lvb sequence number */
241
242 int8_t lkb_status; /* granted, waiting, convert */
243 int8_t lkb_rqmode; /* requested lock mode */
244 int8_t lkb_grmode; /* granted lock mode */
David Teiglande7fd4172006-01-18 09:30:29 +0000245 int8_t lkb_highbast; /* highest mode bast sent for */
David Teigland7fe2b312010-02-24 11:08:18 -0600246
David Teiglande7fd4172006-01-18 09:30:29 +0000247 int8_t lkb_wait_type; /* type of reply waiting for */
David Teiglandef0c2bb2007-03-28 09:56:46 -0500248 int8_t lkb_wait_count;
David Teiglandc6ff6692011-03-28 14:17:26 -0500249 int lkb_wait_nodeid; /* for debugging */
David Teiglande7fd4172006-01-18 09:30:29 +0000250
David Teiglande7fd4172006-01-18 09:30:29 +0000251 struct list_head lkb_statequeue; /* rsb g/c/w list */
252 struct list_head lkb_rsb_lookup; /* waiting for rsb lookup */
253 struct list_head lkb_wait_reply; /* waiting for remote reply */
David Teigland597d0ca2006-07-12 16:44:04 -0500254 struct list_head lkb_ownqueue; /* list of locks for a process */
David Teigland3ae1acf2007-05-18 08:59:31 -0500255 struct list_head lkb_time_list;
David Teiglandeeda4182008-12-09 14:12:21 -0600256 ktime_t lkb_timestamp;
David Teiglandc6ff6692011-03-28 14:17:26 -0500257 ktime_t lkb_wait_time;
David Teigland3ae1acf2007-05-18 08:59:31 -0500258 unsigned long lkb_timeout_cs;
David Teiglande7fd4172006-01-18 09:30:29 +0000259
David Teigland23e8e1a2011-04-05 13:16:24 -0500260 struct mutex lkb_cb_mutex;
261 struct work_struct lkb_cb_work;
262 struct list_head lkb_cb_list; /* for ls_cb_delay or proc->asts */
David Teigland8304d6f2011-02-21 14:58:21 -0600263 struct dlm_callback lkb_callbacks[DLM_CALLBACKS_SIZE];
264 struct dlm_callback lkb_last_cast;
265 struct dlm_callback lkb_last_bast;
266 ktime_t lkb_last_cast_time; /* for debugging */
267 ktime_t lkb_last_bast_time; /* for debugging */
268
David Teigland48756472012-04-26 15:54:29 -0500269 uint64_t lkb_recover_seq; /* from ls_recover_seq */
270
David Teiglande7fd4172006-01-18 09:30:29 +0000271 char *lkb_lvbptr;
272 struct dlm_lksb *lkb_lksb; /* caller's status block */
David Teiglande5dae542008-02-06 00:35:45 -0600273 void (*lkb_astfn) (void *astparam);
274 void (*lkb_bastfn) (void *astparam, int mode);
David Teiglandd292c0c2008-02-06 23:27:04 -0600275 union {
276 void *lkb_astparam; /* caller's ast arg */
277 struct dlm_user_args *lkb_ua;
278 };
David Teiglande7fd4172006-01-18 09:30:29 +0000279};
280
David Teiglandc04fecb2012-05-10 10:18:07 -0500281/*
282 * res_master_nodeid is "normal": 0 is unset/invalid, non-zero is the real
283 * nodeid, even when nodeid is our_nodeid.
284 *
285 * res_nodeid is "odd": -1 is unset/invalid, zero means our_nodeid,
286 * greater than zero when another nodeid.
287 *
288 * (TODO: remove res_nodeid and only use res_master_nodeid)
289 */
David Teiglande7fd4172006-01-18 09:30:29 +0000290
291struct dlm_rsb {
292 struct dlm_ls *res_ls; /* the lockspace */
293 struct kref res_ref;
David Teigland90135922006-01-20 08:47:07 +0000294 struct mutex res_mutex;
David Teiglande7fd4172006-01-18 09:30:29 +0000295 unsigned long res_flags;
296 int res_length; /* length of rsb name */
297 int res_nodeid;
David Teiglandc04fecb2012-05-10 10:18:07 -0500298 int res_master_nodeid;
299 int res_dir_nodeid;
David Teigland1d7c4842012-05-15 16:07:49 -0500300 int res_id; /* for ls_recover_idr */
David Teiglande7fd4172006-01-18 09:30:29 +0000301 uint32_t res_lvbseq;
302 uint32_t res_hash;
303 uint32_t res_bucket; /* rsbtbl */
304 unsigned long res_toss_time;
305 uint32_t res_first_lkid;
306 struct list_head res_lookup; /* lkbs waiting on first */
Bob Peterson9beb3bf2011-10-26 15:24:55 -0500307 union {
308 struct list_head res_hashchain;
309 struct rb_node res_hashnode; /* rsbtbl */
310 };
David Teiglande7fd4172006-01-18 09:30:29 +0000311 struct list_head res_grantqueue;
312 struct list_head res_convertqueue;
313 struct list_head res_waitqueue;
314
315 struct list_head res_root_list; /* used for recovery */
316 struct list_head res_recover_list; /* used for recovery */
317 int res_recover_locks_count;
318
319 char *res_lvbptr;
David Teigland3881ac02011-07-07 14:05:03 -0500320 char res_name[DLM_RESNAME_MAXLEN+1];
David Teiglande7fd4172006-01-18 09:30:29 +0000321};
322
David Teiglandc04fecb2012-05-10 10:18:07 -0500323/* dlm_master_lookup() flags */
324
325#define DLM_LU_RECOVER_DIR 1
326#define DLM_LU_RECOVER_MASTER 2
327
328/* dlm_master_lookup() results */
329
330#define DLM_LU_MATCH 1
331#define DLM_LU_ADD 2
332
David Teiglande7fd4172006-01-18 09:30:29 +0000333/* find_rsb() flags */
334
David Teiglandc04fecb2012-05-10 10:18:07 -0500335#define R_REQUEST 0x00000001
336#define R_RECEIVE_REQUEST 0x00000002
337#define R_RECEIVE_RECOVER 0x00000004
David Teiglande7fd4172006-01-18 09:30:29 +0000338
339/* rsb_flags */
340
341enum rsb_flags {
342 RSB_MASTER_UNCERTAIN,
343 RSB_VALNOTVALID,
344 RSB_VALNOTVALID_PREV,
345 RSB_NEW_MASTER,
346 RSB_NEW_MASTER2,
347 RSB_RECOVER_CONVERT,
David Teigland48756472012-04-26 15:54:29 -0500348 RSB_RECOVER_GRANT,
David Teiglandda8c6662012-11-15 15:01:51 -0600349 RSB_RECOVER_LVB_INVAL,
David Teiglande7fd4172006-01-18 09:30:29 +0000350};
351
352static inline void rsb_set_flag(struct dlm_rsb *r, enum rsb_flags flag)
353{
354 __set_bit(flag, &r->res_flags);
355}
356
357static inline void rsb_clear_flag(struct dlm_rsb *r, enum rsb_flags flag)
358{
359 __clear_bit(flag, &r->res_flags);
360}
361
362static inline int rsb_flag(struct dlm_rsb *r, enum rsb_flags flag)
363{
364 return test_bit(flag, &r->res_flags);
365}
366
367
368/* dlm_header is first element of all structs sent between nodes */
369
David Teigland38aa8b02006-12-13 10:37:16 -0600370#define DLM_HEADER_MAJOR 0x00030000
David Teigland757a4272011-10-20 13:26:28 -0500371#define DLM_HEADER_MINOR 0x00000001
372
373#define DLM_HEADER_SLOTS 0x00000001
David Teiglande7fd4172006-01-18 09:30:29 +0000374
375#define DLM_MSG 1
376#define DLM_RCOM 2
377
378struct dlm_header {
379 uint32_t h_version;
380 uint32_t h_lockspace;
381 uint32_t h_nodeid; /* nodeid of sender */
382 uint16_t h_length;
383 uint8_t h_cmd; /* DLM_MSG, DLM_RCOM */
384 uint8_t h_pad;
385};
386
387
388#define DLM_MSG_REQUEST 1
389#define DLM_MSG_CONVERT 2
390#define DLM_MSG_UNLOCK 3
391#define DLM_MSG_CANCEL 4
392#define DLM_MSG_REQUEST_REPLY 5
393#define DLM_MSG_CONVERT_REPLY 6
394#define DLM_MSG_UNLOCK_REPLY 7
395#define DLM_MSG_CANCEL_REPLY 8
396#define DLM_MSG_GRANT 9
397#define DLM_MSG_BAST 10
398#define DLM_MSG_LOOKUP 11
399#define DLM_MSG_REMOVE 12
400#define DLM_MSG_LOOKUP_REPLY 13
David Teigland84991372007-03-30 15:02:40 -0500401#define DLM_MSG_PURGE 14
David Teiglande7fd4172006-01-18 09:30:29 +0000402
403struct dlm_message {
404 struct dlm_header m_header;
405 uint32_t m_type; /* DLM_MSG_ */
406 uint32_t m_nodeid;
407 uint32_t m_pid;
408 uint32_t m_lkid; /* lkid on sender */
409 uint32_t m_remid; /* lkid on receiver */
410 uint32_t m_parent_lkid;
411 uint32_t m_parent_remid;
412 uint32_t m_exflags;
413 uint32_t m_sbflags;
414 uint32_t m_flags;
415 uint32_t m_lvbseq;
416 uint32_t m_hash;
417 int m_status;
418 int m_grmode;
419 int m_rqmode;
420 int m_bastmode;
421 int m_asts;
422 int m_result; /* 0 or -EXXX */
Gustavo A. R. Silvaa4e439a2020-03-09 10:56:08 -0500423 char m_extra[]; /* name or lvb */
David Teiglande7fd4172006-01-18 09:30:29 +0000424};
425
426
427#define DLM_RS_NODES 0x00000001
428#define DLM_RS_NODES_ALL 0x00000002
429#define DLM_RS_DIR 0x00000004
430#define DLM_RS_DIR_ALL 0x00000008
431#define DLM_RS_LOCKS 0x00000010
432#define DLM_RS_LOCKS_ALL 0x00000020
433#define DLM_RS_DONE 0x00000040
434#define DLM_RS_DONE_ALL 0x00000080
435
436#define DLM_RCOM_STATUS 1
437#define DLM_RCOM_NAMES 2
438#define DLM_RCOM_LOOKUP 3
439#define DLM_RCOM_LOCK 4
440#define DLM_RCOM_STATUS_REPLY 5
441#define DLM_RCOM_NAMES_REPLY 6
442#define DLM_RCOM_LOOKUP_REPLY 7
443#define DLM_RCOM_LOCK_REPLY 8
444
445struct dlm_rcom {
446 struct dlm_header rc_header;
447 uint32_t rc_type; /* DLM_RCOM_ */
448 int rc_result; /* multi-purpose */
449 uint64_t rc_id; /* match reply with request */
David Teigland38aa8b02006-12-13 10:37:16 -0600450 uint64_t rc_seq; /* sender's ls_recover_seq */
451 uint64_t rc_seq_reply; /* remote ls_recover_seq */
Gustavo A. R. Silvaa4e439a2020-03-09 10:56:08 -0500452 char rc_buf[];
David Teiglande7fd4172006-01-18 09:30:29 +0000453};
454
Al Viroeef7d732008-01-25 00:58:46 -0500455union dlm_packet {
456 struct dlm_header header; /* common to other two */
457 struct dlm_message message;
458 struct dlm_rcom rcom;
459};
460
David Teigland757a4272011-10-20 13:26:28 -0500461#define DLM_RSF_NEED_SLOTS 0x00000001
462
463/* RCOM_STATUS data */
464struct rcom_status {
465 __le32 rs_flags;
466 __le32 rs_unused1;
467 __le64 rs_unused2;
468};
469
470/* RCOM_STATUS_REPLY data */
David Teiglande7fd4172006-01-18 09:30:29 +0000471struct rcom_config {
Al Viro93ff2972008-01-25 02:34:00 -0500472 __le32 rf_lvblen;
473 __le32 rf_lsflags;
David Teigland757a4272011-10-20 13:26:28 -0500474
475 /* DLM_HEADER_SLOTS adds: */
476 __le32 rf_flags;
477 __le16 rf_our_slot;
478 __le16 rf_num_slots;
479 __le32 rf_generation;
480 __le32 rf_unused1;
481 __le64 rf_unused2;
482};
483
484struct rcom_slot {
485 __le32 ro_nodeid;
486 __le16 ro_slot;
487 __le16 ro_unused1;
488 __le64 ro_unused2;
David Teiglande7fd4172006-01-18 09:30:29 +0000489};
490
491struct rcom_lock {
Al Viro163a1852008-01-25 02:08:26 -0500492 __le32 rl_ownpid;
493 __le32 rl_lkid;
494 __le32 rl_remid;
495 __le32 rl_parent_lkid;
496 __le32 rl_parent_remid;
497 __le32 rl_exflags;
498 __le32 rl_flags;
499 __le32 rl_lvbseq;
500 __le32 rl_result;
David Teiglande7fd4172006-01-18 09:30:29 +0000501 int8_t rl_rqmode;
502 int8_t rl_grmode;
503 int8_t rl_status;
504 int8_t rl_asts;
Al Viro163a1852008-01-25 02:08:26 -0500505 __le16 rl_wait_type;
506 __le16 rl_namelen;
David Teiglande7fd4172006-01-18 09:30:29 +0000507 char rl_name[DLM_RESNAME_MAXLEN];
Gustavo A. R. Silvaa4e439a2020-03-09 10:56:08 -0500508 char rl_lvb[];
David Teiglande7fd4172006-01-18 09:30:29 +0000509};
510
David Teigland05c32f42012-06-14 12:17:32 -0500511/*
512 * The max number of resources per rsbtbl bucket that shrink will attempt
513 * to remove in each iteration.
514 */
515
516#define DLM_REMOVE_NAMES_MAX 8
517
David Teiglande7fd4172006-01-18 09:30:29 +0000518struct dlm_ls {
519 struct list_head ls_list; /* list of lockspaces */
David Teigland597d0ca2006-07-12 16:44:04 -0500520 dlm_lockspace_t *ls_local_handle;
David Teiglande7fd4172006-01-18 09:30:29 +0000521 uint32_t ls_global_id; /* global unique lockspace ID */
David Teigland757a4272011-10-20 13:26:28 -0500522 uint32_t ls_generation;
David Teiglande7fd4172006-01-18 09:30:29 +0000523 uint32_t ls_exflags;
524 int ls_lvblen;
David Teigland0f8e0d92008-08-06 13:30:24 -0500525 int ls_count; /* refcount of processes in
526 the dlm using this ls */
527 int ls_create_count; /* create/release refcount */
David Teiglande7fd4172006-01-18 09:30:29 +0000528 unsigned long ls_flags; /* LSFL_ */
David Teiglandc1dcf652008-08-18 14:03:25 -0500529 unsigned long ls_scan_time;
David Teiglande7fd4172006-01-18 09:30:29 +0000530 struct kobject ls_kobj;
531
David Teigland3d6aa672011-07-06 17:00:54 -0500532 struct idr ls_lkbidr;
533 spinlock_t ls_lkbidr_spin;
534
David Teiglande7fd4172006-01-18 09:30:29 +0000535 struct dlm_rsbtable *ls_rsbtbl;
536 uint32_t ls_rsbtbl_size;
537
David Teigland90135922006-01-20 08:47:07 +0000538 struct mutex ls_waiters_mutex;
David Teiglande7fd4172006-01-18 09:30:29 +0000539 struct list_head ls_waiters; /* lkbs needing a reply */
540
David Teiglandef0c2bb2007-03-28 09:56:46 -0500541 struct mutex ls_orphans_mutex;
542 struct list_head ls_orphans;
543
David Teigland3ae1acf2007-05-18 08:59:31 -0500544 struct mutex ls_timeout_mutex;
545 struct list_head ls_timeout;
546
David Teigland3881ac02011-07-07 14:05:03 -0500547 spinlock_t ls_new_rsb_spin;
548 int ls_new_rsb_count;
549 struct list_head ls_new_rsb; /* new rsb structs */
550
David Teigland05c32f42012-06-14 12:17:32 -0500551 spinlock_t ls_remove_spin;
552 char ls_remove_name[DLM_RESNAME_MAXLEN+1];
553 char *ls_remove_names[DLM_REMOVE_NAMES_MAX];
554 int ls_remove_len;
555 int ls_remove_lens[DLM_REMOVE_NAMES_MAX];
556
David Teiglande7fd4172006-01-18 09:30:29 +0000557 struct list_head ls_nodes; /* current nodes in ls */
558 struct list_head ls_nodes_gone; /* dead node list, recovery */
559 int ls_num_nodes; /* number of nodes in ls */
560 int ls_low_nodeid;
561 int ls_total_weight;
562 int *ls_node_array;
563
David Teigland757a4272011-10-20 13:26:28 -0500564 int ls_slot;
565 int ls_num_slots;
566 int ls_slots_size;
567 struct dlm_slot *ls_slots;
568
David Teiglande7fd4172006-01-18 09:30:29 +0000569 struct dlm_rsb ls_stub_rsb; /* for returning errors */
570 struct dlm_lkb ls_stub_lkb; /* for returning errors */
571 struct dlm_message ls_stub_ms; /* for faking a reply */
572
David Teigland5de63192006-07-25 13:44:31 -0500573 struct dentry *ls_debug_rsb_dentry; /* debugfs */
574 struct dentry *ls_debug_waiters_dentry; /* debugfs */
David Teiglandac90a252007-07-06 09:47:08 -0500575 struct dentry *ls_debug_locks_dentry; /* debugfs */
David Teiglandd0225092008-12-16 14:53:23 -0600576 struct dentry *ls_debug_all_dentry; /* debugfs */
David Teiglandc04fecb2012-05-10 10:18:07 -0500577 struct dentry *ls_debug_toss_dentry; /* debugfs */
David Teiglande7fd4172006-01-18 09:30:29 +0000578
579 wait_queue_head_t ls_uevent_wait; /* user part of join/leave */
580 int ls_uevent_result;
David Teigland8b0e7b22007-05-18 09:03:35 -0500581 struct completion ls_members_done;
582 int ls_members_result;
David Teiglande7fd4172006-01-18 09:30:29 +0000583
David Teigland597d0ca2006-07-12 16:44:04 -0500584 struct miscdevice ls_device;
585
David Teigland23e8e1a2011-04-05 13:16:24 -0500586 struct workqueue_struct *ls_callback_wq;
587
David Teiglande7fd4172006-01-18 09:30:29 +0000588 /* recovery related */
589
David Teigland23e8e1a2011-04-05 13:16:24 -0500590 struct mutex ls_cb_mutex;
591 struct list_head ls_cb_delay; /* save for queue_work later */
David Teiglande7fd4172006-01-18 09:30:29 +0000592 struct timer_list ls_timer;
593 struct task_struct *ls_recoverd_task;
David Teigland90135922006-01-20 08:47:07 +0000594 struct mutex ls_recoverd_active;
David Teiglande7fd4172006-01-18 09:30:29 +0000595 spinlock_t ls_recover_lock;
David Teigland3ae1acf2007-05-18 08:59:31 -0500596 unsigned long ls_recover_begin; /* jiffies timestamp */
David Teiglande7fd4172006-01-18 09:30:29 +0000597 uint32_t ls_recover_status; /* DLM_RS_ */
598 uint64_t ls_recover_seq;
599 struct dlm_recover *ls_recover_args;
600 struct rw_semaphore ls_in_recovery; /* block local requests */
David Teiglandc36258b2007-09-27 15:53:38 -0500601 struct rw_semaphore ls_recv_active; /* block dlm_recv */
David Teiglande7fd4172006-01-18 09:30:29 +0000602 struct list_head ls_requestqueue;/* queue remote requests */
David Teigland90135922006-01-20 08:47:07 +0000603 struct mutex ls_requestqueue_mutex;
Al Viro40076852008-01-25 03:01:51 -0500604 struct dlm_rcom *ls_recover_buf;
David Teiglandfaa0f262006-08-08 17:08:42 -0500605 int ls_recover_nodeid; /* for debugging */
David Teiglandc04fecb2012-05-10 10:18:07 -0500606 unsigned int ls_recover_dir_sent_res; /* for log info */
607 unsigned int ls_recover_dir_sent_msg; /* for log info */
David Teigland48756472012-04-26 15:54:29 -0500608 unsigned int ls_recover_locks_in; /* for log info */
David Teigland4a99c3d2006-08-09 11:20:15 -0500609 uint64_t ls_rcom_seq;
David Teigland98f176f2006-11-27 13:19:28 -0600610 spinlock_t ls_rcom_spin;
David Teiglande7fd4172006-01-18 09:30:29 +0000611 struct list_head ls_recover_list;
612 spinlock_t ls_recover_list_lock;
613 int ls_recover_list_count;
David Teigland1d7c4842012-05-15 16:07:49 -0500614 struct idr ls_recover_idr;
615 spinlock_t ls_recover_idr_lock;
David Teiglande7fd4172006-01-18 09:30:29 +0000616 wait_queue_head_t ls_wait_general;
David Teigland475f2302012-08-02 11:08:21 -0500617 wait_queue_head_t ls_recover_lock_wait;
David Teigland597d0ca2006-07-12 16:44:04 -0500618 struct mutex ls_clear_proc_locks;
David Teiglande7fd4172006-01-18 09:30:29 +0000619
620 struct list_head ls_root_list; /* root resources */
621 struct rw_semaphore ls_root_sem; /* protect root_list */
622
David Teigland60f98d12011-11-02 14:30:58 -0500623 const struct dlm_lockspace_ops *ls_ops;
624 void *ls_ops_arg;
625
David Teiglande7fd4172006-01-18 09:30:29 +0000626 int ls_namelen;
627 char ls_name[1];
628};
629
David Teigland475f2302012-08-02 11:08:21 -0500630/*
631 * LSFL_RECOVER_STOP - dlm_ls_stop() sets this to tell dlm recovery routines
632 * that they should abort what they're doing so new recovery can be started.
633 *
634 * LSFL_RECOVER_DOWN - dlm_ls_stop() sets this to tell dlm_recoverd that it
635 * should do down_write() on the in_recovery rw_semaphore. (doing down_write
636 * within dlm_ls_stop causes complaints about the lock acquired/released
637 * in different contexts.)
638 *
639 * LSFL_RECOVER_LOCK - dlm_recoverd holds the in_recovery rw_semaphore.
640 * It sets this after it is done with down_write() on the in_recovery
641 * rw_semaphore and clears it after it has released the rw_semaphore.
642 *
643 * LSFL_RECOVER_WORK - dlm_ls_start() sets this to tell dlm_recoverd that it
644 * should begin recovery of the lockspace.
645 *
646 * LSFL_RUNNING - set when normal locking activity is enabled.
647 * dlm_ls_stop() clears this to tell dlm locking routines that they should
648 * quit what they are doing so recovery can run. dlm_recoverd sets
649 * this after recovery is finished.
650 */
651
652#define LSFL_RECOVER_STOP 0
653#define LSFL_RECOVER_DOWN 1
654#define LSFL_RECOVER_LOCK 2
655#define LSFL_RECOVER_WORK 3
656#define LSFL_RUNNING 4
657
658#define LSFL_RCOM_READY 5
659#define LSFL_RCOM_WAIT 6
660#define LSFL_UEVENT_WAIT 7
661#define LSFL_TIMEWARN 8
662#define LSFL_CB_DELAY 9
663#define LSFL_NODIR 10
David Teiglande7fd4172006-01-18 09:30:29 +0000664
David Teigland597d0ca2006-07-12 16:44:04 -0500665/* much of this is just saving user space pointers associated with the
666 lock that we pass back to the user lib with an ast */
667
668struct dlm_user_args {
669 struct dlm_user_proc *proc; /* each process that opens the lockspace
670 device has private data
671 (dlm_user_proc) on the struct file,
672 the process's locks point back to it*/
673 struct dlm_lksb lksb;
David Teigland597d0ca2006-07-12 16:44:04 -0500674 struct dlm_lksb __user *user_lksb;
675 void __user *castparam;
676 void __user *castaddr;
677 void __user *bastparam;
678 void __user *bastaddr;
David Teiglandd7db9232007-05-18 09:00:32 -0500679 uint64_t xid;
David Teigland597d0ca2006-07-12 16:44:04 -0500680};
681
682#define DLM_PROC_FLAGS_CLOSING 1
683#define DLM_PROC_FLAGS_COMPAT 2
684
685/* locks list is kept so we can remove all a process's locks when it
686 exits (or orphan those that are persistent) */
687
688struct dlm_user_proc {
689 dlm_lockspace_t *lockspace;
690 unsigned long flags; /* DLM_PROC_FLAGS */
691 struct list_head asts;
692 spinlock_t asts_spin;
693 struct list_head locks;
694 spinlock_t locks_spin;
David Teiglanda1bc86e2007-01-15 10:34:52 -0600695 struct list_head unlocking;
David Teigland597d0ca2006-07-12 16:44:04 -0500696 wait_queue_head_t wait;
697};
698
David Teiglande7fd4172006-01-18 09:30:29 +0000699static inline int dlm_locking_stopped(struct dlm_ls *ls)
700{
701 return !test_bit(LSFL_RUNNING, &ls->ls_flags);
702}
703
704static inline int dlm_recovery_stopped(struct dlm_ls *ls)
705{
David Teigland475f2302012-08-02 11:08:21 -0500706 return test_bit(LSFL_RECOVER_STOP, &ls->ls_flags);
David Teiglande7fd4172006-01-18 09:30:29 +0000707}
708
709static inline int dlm_no_directory(struct dlm_ls *ls)
710{
David Teigland48756472012-04-26 15:54:29 -0500711 return test_bit(LSFL_NODIR, &ls->ls_flags);
David Teiglande7fd4172006-01-18 09:30:29 +0000712}
713
Adrian Bunke0283982007-11-03 01:04:30 +0100714int dlm_netlink_init(void);
715void dlm_netlink_exit(void);
716void dlm_timeout_warn(struct dlm_lkb *lkb);
David Teigland24022112008-03-14 15:09:15 -0500717int dlm_plock_init(void);
718void dlm_plock_exit(void);
Adrian Bunke0283982007-11-03 01:04:30 +0100719
720#ifdef CONFIG_DLM_DEBUG
Greg Kroah-Hartmana48f9722019-06-12 17:25:36 +0200721void dlm_register_debugfs(void);
Adrian Bunke0283982007-11-03 01:04:30 +0100722void dlm_unregister_debugfs(void);
Greg Kroah-Hartmana48f9722019-06-12 17:25:36 +0200723void dlm_create_debug_file(struct dlm_ls *ls);
Adrian Bunke0283982007-11-03 01:04:30 +0100724void dlm_delete_debug_file(struct dlm_ls *ls);
725#else
Greg Kroah-Hartmana48f9722019-06-12 17:25:36 +0200726static inline void dlm_register_debugfs(void) { }
Adrian Bunke0283982007-11-03 01:04:30 +0100727static inline void dlm_unregister_debugfs(void) { }
Greg Kroah-Hartmana48f9722019-06-12 17:25:36 +0200728static inline void dlm_create_debug_file(struct dlm_ls *ls) { }
Adrian Bunke0283982007-11-03 01:04:30 +0100729static inline void dlm_delete_debug_file(struct dlm_ls *ls) { }
730#endif
731
David Teiglande7fd4172006-01-18 09:30:29 +0000732#endif /* __DLM_INTERNAL_DOT_H__ */
733