[linux.git] / fs / ocfs2 / cluster / heartbeat.h

/* -*- mode: c; c-basic-offset: 8; -*-
 * vim: noexpandtab sw=8 ts=8 sts=0:
 *
 * heartbeat.h
 *
 * Function prototypes
 *
 * Copyright (C) 2004 Oracle.  All rights reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 021110-1307, USA.
 *
 */

#ifndef O2CLUSTER_HEARTBEAT_H
#define O2CLUSTER_HEARTBEAT_H

#include "ocfs2_heartbeat.h"

#define O2HB_REGION_TIMEOUT_MS		2000

#define O2HB_MAX_REGION_NAME_LEN	32

/* number of changes to be seen as live */
#define O2HB_LIVE_THRESHOLD	   2
/* number of equal samples to be seen as dead */
extern unsigned int o2hb_dead_threshold;
#define O2HB_DEFAULT_DEAD_THRESHOLD	   31
/* Otherwise MAX_WRITE_TIMEOUT will be zero... */
#define O2HB_MIN_DEAD_THRESHOLD	  2
#define O2HB_MAX_WRITE_TIMEOUT_MS (O2HB_REGION_TIMEOUT_MS * (o2hb_dead_threshold - 1))

#define O2HB_CB_MAGIC		0x51d1e4ec

/* callback stuff */
enum o2hb_callback_type {
	O2HB_NODE_DOWN_CB = 0,
	O2HB_NODE_UP_CB,
	O2HB_NUM_CB
};

struct o2nm_node;
typedef void (o2hb_cb_func)(struct o2nm_node *, int, void *);

struct o2hb_callback_func {
	u32			hc_magic;
	struct list_head	hc_item;
	o2hb_cb_func		*hc_func;
	void			*hc_data;
	int			hc_priority;
	enum o2hb_callback_type hc_type;
};

struct config_group *o2hb_alloc_hb_set(void);
void o2hb_free_hb_set(struct config_group *group);

void o2hb_setup_callback(struct o2hb_callback_func *hc,
			 enum o2hb_callback_type type,
			 o2hb_cb_func *func,
			 void *data,
			 int priority);
int o2hb_register_callback(const char *region_uuid,
			   struct o2hb_callback_func *hc);
void o2hb_unregister_callback(const char *region_uuid,
			      struct o2hb_callback_func *hc);
void o2hb_fill_node_map(unsigned long *map,
			unsigned bytes);
void o2hb_exit(void);
int o2hb_init(void);
int o2hb_check_node_heartbeating(u8 node_num);
int o2hb_check_node_heartbeating_from_callback(u8 node_num);
int o2hb_check_local_node_heartbeating(void);
void o2hb_stop_all_regions(void);
int o2hb_get_all_regions(char *region_uuids, u8 numregions);
int o2hb_global_heartbeat_active(void);

#endif /* O2CLUSTER_HEARTBEAT_H */
Commit	Line	Data
a7f6a5fb MF	1	/* -- mode: c; c-basic-offset: 8; --
	2	* vim: noexpandtab sw=8 ts=8 sts=0:
	3	*
	4	* heartbeat.h
	5	*
	6	* Function prototypes
	7	*
	8	* Copyright (C) 2004 Oracle. All rights reserved.
	9	*
	10	* This program is free software; you can redistribute it and/or
	11	* modify it under the terms of the GNU General Public
	12	* License as published by the Free Software Foundation; either
	13	* version 2 of the License, or (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	18	* General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public
	21	* License along with this program; if not, write to the
	22	* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
	23	* Boston, MA 021110-1307, USA.
	24	*
	25	*/
	26
	27	#ifndef O2CLUSTER_HEARTBEAT_H
	28	#define O2CLUSTER_HEARTBEAT_H
	29
	30	#include "ocfs2_heartbeat.h"
	31
	32	#define O2HB_REGION_TIMEOUT_MS 2000
	33
b3c85c4c SM	34	#define O2HB_MAX_REGION_NAME_LEN 32
b3c85c4c SM	35
a7f6a5fb MF	36	/* number of changes to be seen as live */
	37	#define O2HB_LIVE_THRESHOLD 2
	38	/* number of equal samples to be seen as dead */
	39	extern unsigned int o2hb_dead_threshold;
17104683	40	#define O2HB_DEFAULT_DEAD_THRESHOLD 31
a7f6a5fb MF	41	/* Otherwise MAX_WRITE_TIMEOUT will be zero... */
	42	#define O2HB_MIN_DEAD_THRESHOLD 2
	43	#define O2HB_MAX_WRITE_TIMEOUT_MS (O2HB_REGION_TIMEOUT_MS * (o2hb_dead_threshold - 1))
	44
	45	#define O2HB_CB_MAGIC 0x51d1e4ec
	46
	47	/* callback stuff */
	48	enum o2hb_callback_type {
	49	O2HB_NODE_DOWN_CB = 0,
	50	O2HB_NODE_UP_CB,
	51	O2HB_NUM_CB
	52	};
	53
	54	struct o2nm_node;
	55	typedef void (o2hb_cb_func)(struct o2nm_node , int, void );
	56
	57	struct o2hb_callback_func {
	58	u32 hc_magic;
	59	struct list_head hc_item;
	60	o2hb_cb_func *hc_func;
	61	void *hc_data;
	62	int hc_priority;
	63	enum o2hb_callback_type hc_type;
	64	};
	65
	66	struct config_group *o2hb_alloc_hb_set(void);
	67	void o2hb_free_hb_set(struct config_group *group);
	68
	69	void o2hb_setup_callback(struct o2hb_callback_func *hc,
	70	enum o2hb_callback_type type,
	71	o2hb_cb_func *func,
	72	void *data,
	73	int priority);
14829422 JB	74	int o2hb_register_callback(const char *region_uuid,
	75	struct o2hb_callback_func *hc);
	76	void o2hb_unregister_callback(const char *region_uuid,
	77	struct o2hb_callback_func *hc);
a7f6a5fb MF	78	void o2hb_fill_node_map(unsigned long *map,
a7f6a5fb MF	79	unsigned bytes);
87d3d3f3 SM	80	void o2hb_exit(void);
87d3d3f3 SM	81	int o2hb_init(void);
a7f6a5fb MF	82	int o2hb_check_node_heartbeating(u8 node_num);
	83	int o2hb_check_node_heartbeating_from_callback(u8 node_num);
	84	int o2hb_check_local_node_heartbeating(void);
	85	void o2hb_stop_all_regions(void);
b3c85c4c SM	86	int o2hb_get_all_regions(char *region_uuids, u8 numregions);
b3c85c4c SM	87	int o2hb_global_heartbeat_active(void);
a7f6a5fb MF	88
a7f6a5fb MF	89	#endif /* O2CLUSTER_HEARTBEAT_H */