xref: /openbmc/linux/fs/ocfs2/cluster/heartbeat.h (revision bb3982b4)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* -*- mode: c; c-basic-offset: 8; -*-
3  * vim: noexpandtab sw=8 ts=8 sts=0:
4  *
5  * heartbeat.h
6  *
7  * Function prototypes
8  *
9  * Copyright (C) 2004 Oracle.  All rights reserved.
10  */
11 
12 #ifndef O2CLUSTER_HEARTBEAT_H
13 #define O2CLUSTER_HEARTBEAT_H
14 
15 #include "ocfs2_heartbeat.h"
16 
17 #define O2HB_REGION_TIMEOUT_MS		2000
18 
19 #define O2HB_MAX_REGION_NAME_LEN	32
20 
21 /* number of changes to be seen as live */
22 #define O2HB_LIVE_THRESHOLD	   2
23 /* number of equal samples to be seen as dead */
24 extern unsigned int o2hb_dead_threshold;
25 #define O2HB_DEFAULT_DEAD_THRESHOLD	   31
26 /* Otherwise MAX_WRITE_TIMEOUT will be zero... */
27 #define O2HB_MIN_DEAD_THRESHOLD	  2
28 #define O2HB_MAX_WRITE_TIMEOUT_MS (O2HB_REGION_TIMEOUT_MS * (o2hb_dead_threshold - 1))
29 
30 #define O2HB_CB_MAGIC		0x51d1e4ec
31 
32 /* callback stuff */
33 enum o2hb_callback_type {
34 	O2HB_NODE_DOWN_CB = 0,
35 	O2HB_NODE_UP_CB,
36 	O2HB_NUM_CB
37 };
38 
39 struct o2nm_node;
40 typedef void (o2hb_cb_func)(struct o2nm_node *, int, void *);
41 
42 struct o2hb_callback_func {
43 	u32			hc_magic;
44 	struct list_head	hc_item;
45 	o2hb_cb_func		*hc_func;
46 	void			*hc_data;
47 	int			hc_priority;
48 	enum o2hb_callback_type hc_type;
49 };
50 
51 struct config_group *o2hb_alloc_hb_set(void);
52 void o2hb_free_hb_set(struct config_group *group);
53 
54 void o2hb_setup_callback(struct o2hb_callback_func *hc,
55 			 enum o2hb_callback_type type,
56 			 o2hb_cb_func *func,
57 			 void *data,
58 			 int priority);
59 int o2hb_register_callback(const char *region_uuid,
60 			   struct o2hb_callback_func *hc);
61 void o2hb_unregister_callback(const char *region_uuid,
62 			      struct o2hb_callback_func *hc);
63 void o2hb_fill_node_map(unsigned long *map,
64 			unsigned bytes);
65 void o2hb_exit(void);
66 int o2hb_init(void);
67 int o2hb_check_node_heartbeating_no_sem(u8 node_num);
68 int o2hb_check_node_heartbeating_from_callback(u8 node_num);
69 void o2hb_stop_all_regions(void);
70 int o2hb_get_all_regions(char *region_uuids, u8 numregions);
71 int o2hb_global_heartbeat_active(void);
72 
73 #endif /* O2CLUSTER_HEARTBEAT_H */
74