[linux-2.6-block.git] / fs / ocfs2 / stackglue.h

/* -*- mode: c; c-basic-offset: 8; -*-
 * vim: noexpandtab sw=8 ts=8 sts=0:
 *
 * stackglue.h
 *
 * Glue to the underlying cluster stack.
 *
 * Copyright (C) 2007 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, version 2.
 *
 * 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.
 */


#ifndef STACKGLUE_H
#define STACKGLUE_H

#include <linux/types.h>
#include <linux/list.h>
#include <linux/dlmconstants.h>

#include "dlm/dlmapi.h"
#include <linux/dlm.h>

/* Needed for plock-related prototypes */
struct file;
struct file_lock;

/*
 * dlmconstants.h does not have a LOCAL flag.  We hope to remove it
 * some day, but right now we need it.  Let's fake it.  This value is larger
 * than any flag in dlmconstants.h.
 */
#define DLM_LKF_LOCAL		0x00100000

/*
 * This shadows DLM_LOCKSPACE_LEN in fs/dlm/dlm_internal.h.  That probably
 * wants to be in a public header.
 */
#define GROUP_NAME_MAX		64

/* This shadows  OCFS2_CLUSTER_NAME_LEN */
#define CLUSTER_NAME_MAX	16


/*
 * ocfs2_protocol_version changes when ocfs2 does something different in
 * its inter-node behavior.  See dlmglue.c for more information.
 */
struct ocfs2_protocol_version {
	u8 pv_major;
	u8 pv_minor;
};

/*
 * The dlm_lockstatus struct includes lvb space, but the dlm_lksb struct only
 * has a pointer to separately allocated lvb space.  This struct exists only to
 * include in the lksb union to make space for a combined dlm_lksb and lvb.
 */
struct fsdlm_lksb_plus_lvb {
	struct dlm_lksb lksb;
	char lvb[DLM_LVB_LEN];
};

/*
 * A union of all lock status structures.  We define it here so that the
 * size of the union is known.  Lock status structures are embedded in
 * ocfs2 inodes.
 */
struct ocfs2_cluster_connection;
struct ocfs2_dlm_lksb {
	 union {
		 struct dlm_lockstatus lksb_o2dlm;
		 struct dlm_lksb lksb_fsdlm;
		 struct fsdlm_lksb_plus_lvb padding;
	 };
	 struct ocfs2_cluster_connection *lksb_conn;
};

/*
 * The ocfs2_locking_protocol defines the handlers called on ocfs2's behalf.
 */
struct ocfs2_locking_protocol {
	struct ocfs2_protocol_version lp_max_version;
	void (*lp_lock_ast)(struct ocfs2_dlm_lksb *lksb);
	void (*lp_blocking_ast)(struct ocfs2_dlm_lksb *lksb, int level);
	void (*lp_unlock_ast)(struct ocfs2_dlm_lksb *lksb, int error);
};


/*
 * A cluster connection.  Mostly opaque to ocfs2, the connection holds
 * state for the underlying stack.  ocfs2 does use cc_version to determine
 * locking compatibility.
 */
struct ocfs2_cluster_connection {
	char cc_name[GROUP_NAME_MAX + 1];
	int cc_namelen;
	char cc_cluster_name[CLUSTER_NAME_MAX + 1];
	int cc_cluster_name_len;
	struct ocfs2_protocol_version cc_version;
	struct ocfs2_locking_protocol *cc_proto;
	void (*cc_recovery_handler)(int node_num, void *recovery_data);
	void *cc_recovery_data;
	void *cc_lockspace;
	void *cc_private;
};

/*
 * Each cluster stack implements the stack operations structure.  Not used
 * in the ocfs2 code, the stackglue code translates generic cluster calls
 * into stack operations.
 */
struct ocfs2_stack_operations {
	/*
	 * The fs code calls ocfs2_cluster_connect() to attach a new
	 * filesystem to the cluster stack.  The ->connect() op is passed
	 * an ocfs2_cluster_connection with the name and recovery field
	 * filled in.
	 *
	 * The stack must set up any notification mechanisms and create
	 * the filesystem lockspace in the DLM.  The lockspace should be
	 * stored on cc_lockspace.  Any other information can be stored on
	 * cc_private.
	 *
	 * ->connect() must not return until it is guaranteed that
	 *
	 *  - Node down notifications for the filesystem will be received
	 *    and passed to conn->cc_recovery_handler().
	 *  - Locking requests for the filesystem will be processed.
	 */
	int (*connect)(struct ocfs2_cluster_connection *conn);

	/*
	 * The fs code calls ocfs2_cluster_disconnect() when a filesystem
	 * no longer needs cluster services.  All DLM locks have been
	 * dropped, and recovery notification is being ignored by the
	 * fs code.  The stack must disengage from the DLM and discontinue
	 * recovery notification.
	 *
	 * Once ->disconnect() has returned, the connection structure will
	 * be freed.  Thus, a stack must not return from ->disconnect()
	 * until it will no longer reference the conn pointer.
	 *
	 * Once this call returns, the stack glue will be dropping this
	 * connection's reference on the module.
	 */
	int (*disconnect)(struct ocfs2_cluster_connection *conn);

	/*
	 * ->this_node() returns the cluster's unique identifier for the
	 * local node.
	 */
	int (*this_node)(struct ocfs2_cluster_connection *conn,
			 unsigned int *node);

	/*
	 * Call the underlying dlm lock function.  The ->dlm_lock()
	 * callback should convert the flags and mode as appropriate.
	 *
	 * ast and bast functions are not part of the call because the
	 * stack will likely want to wrap ast and bast calls before passing
	 * them to stack->sp_proto.  There is no astarg.  The lksb will
	 * be passed back to the ast and bast functions.  The caller can
	 * use this to find their object.
	 */
	int (*dlm_lock)(struct ocfs2_cluster_connection *conn,
			int mode,
			struct ocfs2_dlm_lksb *lksb,
			u32 flags,
			void *name,
			unsigned int namelen);

	/*
	 * Call the underlying dlm unlock function.  The ->dlm_unlock()
	 * function should convert the flags as appropriate.
	 *
	 * The unlock ast is not passed, as the stack will want to wrap
	 * it before calling stack->sp_proto->lp_unlock_ast().  There is
	 * no astarg.  The lksb will be passed back to the unlock ast
	 * function.  The caller can use this to find their object.
	 */
	int (*dlm_unlock)(struct ocfs2_cluster_connection *conn,
			  struct ocfs2_dlm_lksb *lksb,
			  u32 flags);

	/*
	 * Return the status of the current lock status block.  The fs
	 * code should never dereference the union.  The ->lock_status()
	 * callback pulls out the stack-specific lksb, converts the status
	 * to a proper errno, and returns it.
	 */
	int (*lock_status)(struct ocfs2_dlm_lksb *lksb);

	/*
	 * Return non-zero if the LVB is valid.
	 */
	int (*lvb_valid)(struct ocfs2_dlm_lksb *lksb);

	/*
	 * Pull the lvb pointer off of the stack-specific lksb.
	 */
	void *(*lock_lvb)(struct ocfs2_dlm_lksb *lksb);

	/*
	 * Cluster-aware posix locks
	 *
	 * This is NULL for stacks which do not support posix locks.
	 */
	int (*plock)(struct ocfs2_cluster_connection *conn,
		     u64 ino,
		     struct file *file,
		     int cmd,
		     struct file_lock *fl);

	/*
	 * This is an optoinal debugging hook.  If provided, the
	 * stack can dump debugging information about this lock.
	 */
	void (*dump_lksb)(struct ocfs2_dlm_lksb *lksb);
};

/*
 * Each stack plugin must describe itself by registering a
 * ocfs2_stack_plugin structure.  This is only seen by stackglue and the
 * stack driver.
 */
struct ocfs2_stack_plugin {
	char *sp_name;
	struct ocfs2_stack_operations *sp_ops;
	struct module *sp_owner;

	/* These are managed by the stackglue code. */
	struct list_head sp_list;
	unsigned int sp_count;
	struct ocfs2_protocol_version sp_max_proto;
};


/* Used by the filesystem */
int ocfs2_cluster_connect(const char *stack_name,
			  const char *cluster_name,
			  int cluster_name_len,
			  const char *group,
			  int grouplen,
			  struct ocfs2_locking_protocol *lproto,
			  void (*recovery_handler)(int node_num,
						   void *recovery_data),
			  void *recovery_data,
			  struct ocfs2_cluster_connection **conn);
/*
 * Used by callers that don't store their stack name.  They must ensure
 * all nodes have the same stack.
 */
int ocfs2_cluster_connect_agnostic(const char *group,
				   int grouplen,
				   struct ocfs2_locking_protocol *lproto,
				   void (*recovery_handler)(int node_num,
							    void *recovery_data),
				   void *recovery_data,
				   struct ocfs2_cluster_connection **conn);
int ocfs2_cluster_disconnect(struct ocfs2_cluster_connection *conn,
			     int hangup_pending);
void ocfs2_cluster_hangup(const char *group, int grouplen);
int ocfs2_cluster_this_node(struct ocfs2_cluster_connection *conn,
			    unsigned int *node);

struct ocfs2_lock_res;
int ocfs2_dlm_lock(struct ocfs2_cluster_connection *conn,
		   int mode,
		   struct ocfs2_dlm_lksb *lksb,
		   u32 flags,
		   void *name,
		   unsigned int namelen);
int ocfs2_dlm_unlock(struct ocfs2_cluster_connection *conn,
		     struct ocfs2_dlm_lksb *lksb,
		     u32 flags);

int ocfs2_dlm_lock_status(struct ocfs2_dlm_lksb *lksb);
int ocfs2_dlm_lvb_valid(struct ocfs2_dlm_lksb *lksb);
void *ocfs2_dlm_lvb(struct ocfs2_dlm_lksb *lksb);
void ocfs2_dlm_dump_lksb(struct ocfs2_dlm_lksb *lksb);

int ocfs2_stack_supports_plocks(void);
int ocfs2_plock(struct ocfs2_cluster_connection *conn, u64 ino,
		struct file *file, int cmd, struct file_lock *fl);

void ocfs2_stack_glue_set_max_proto_version(struct ocfs2_protocol_version *max_proto);


/* Used by stack plugins */
int ocfs2_stack_glue_register(struct ocfs2_stack_plugin *plugin);
void ocfs2_stack_glue_unregister(struct ocfs2_stack_plugin *plugin);

#endif  /* STACKGLUE_H */
Commit	Line	Data
24ef1815 JB	1	/* -- mode: c; c-basic-offset: 8; --
	2	* vim: noexpandtab sw=8 ts=8 sts=0:
	3	*
	4	* stackglue.h
	5	*
	6	* Glue to the underlying cluster stack.
	7	*
	8	* Copyright (C) 2007 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, version 2.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	17	* General Public License for more details.
	18	*/
	19
	20
	21	#ifndef STACKGLUE_H
	22	#define STACKGLUE_H
	23
bd3e7610 JB	24	#include <linux/types.h>
	25	#include <linux/list.h>
	26	#include <linux/dlmconstants.h>
	27
e3dad42b	28	#include "dlm/dlmapi.h"
cf4d8d75	29	#include <linux/dlm.h>
e3dad42b	30
53da4939 MF	31	/* Needed for plock-related prototypes */
	32	struct file;
	33	struct file_lock;
	34
bd3e7610 JB	35	/*
	36	* dlmconstants.h does not have a LOCAL flag. We hope to remove it
	37	* some day, but right now we need it. Let's fake it. This value is larger
	38	* than any flag in dlmconstants.h.
	39	*/
	40	#define DLM_LKF_LOCAL 0x00100000
	41
4670c46d JB	42	/*
	43	* This shadows DLM_LOCKSPACE_LEN in fs/dlm/dlm_internal.h. That probably
	44	* wants to be in a public header.
	45	*/
	46	#define GROUP_NAME_MAX 64
	47
c74a3bdd GR	48	/* This shadows OCFS2_CLUSTER_NAME_LEN */
	49	#define CLUSTER_NAME_MAX 16
	50
4670c46d	51
e3dad42b JB	52	/*
	53	* ocfs2_protocol_version changes when ocfs2 does something different in
	54	* its inter-node behavior. See dlmglue.c for more information.
	55	*/
4670c46d JB	56	struct ocfs2_protocol_version {
	57	u8 pv_major;
	58	u8 pv_minor;
	59	};
	60
cf4d8d75 DT	61	/*
	62	* The dlm_lockstatus struct includes lvb space, but the dlm_lksb struct only
	63	* has a pointer to separately allocated lvb space. This struct exists only to
	64	* include in the lksb union to make space for a combined dlm_lksb and lvb.
	65	*/
	66	struct fsdlm_lksb_plus_lvb {
	67	struct dlm_lksb lksb;
	68	char lvb[DLM_LVB_LEN];
	69	};
	70
e3dad42b JB	71	/*
	72	* A union of all lock status structures. We define it here so that the
	73	* size of the union is known. Lock status structures are embedded in
	74	* ocfs2 inodes.
	75	*/
c0e41338 JB	76	struct ocfs2_cluster_connection;
	77	struct ocfs2_dlm_lksb {
	78	union {
	79	struct dlm_lockstatus lksb_o2dlm;
	80	struct dlm_lksb lksb_fsdlm;
	81	struct fsdlm_lksb_plus_lvb padding;
	82	};
	83	struct ocfs2_cluster_connection *lksb_conn;
8f2c9c1b JB	84	};
8f2c9c1b JB	85
a796d286 JB	86	/*
	87	* The ocfs2_locking_protocol defines the handlers called on ocfs2's behalf.
	88	*/
	89	struct ocfs2_locking_protocol {
	90	struct ocfs2_protocol_version lp_max_version;
c0e41338 JB	91	void (lp_lock_ast)(struct ocfs2_dlm_lksb lksb);
	92	void (lp_blocking_ast)(struct ocfs2_dlm_lksb lksb, int level);
	93	void (lp_unlock_ast)(struct ocfs2_dlm_lksb lksb, int error);
a796d286 JB	94	};
	95
	96
e3dad42b JB	97	/*
	98	* A cluster connection. Mostly opaque to ocfs2, the connection holds
	99	* state for the underlying stack. ocfs2 does use cc_version to determine
	100	* locking compatibility.
	101	*/
4670c46d	102	struct ocfs2_cluster_connection {
c74a3bdd	103	char cc_name[GROUP_NAME_MAX + 1];
4670c46d	104	int cc_namelen;
c74a3bdd GR	105	char cc_cluster_name[CLUSTER_NAME_MAX + 1];
c74a3bdd GR	106	int cc_cluster_name_len;
4670c46d	107	struct ocfs2_protocol_version cc_version;
110946c8	108	struct ocfs2_locking_protocol *cc_proto;
4670c46d JB	109	void (cc_recovery_handler)(int node_num, void recovery_data);
	110	void *cc_recovery_data;
	111	void *cc_lockspace;
	112	void *cc_private;
	113	};
	114
e3dad42b JB	115	/*
	116	* Each cluster stack implements the stack operations structure. Not used
	117	* in the ocfs2 code, the stackglue code translates generic cluster calls
	118	* into stack operations.
	119	*/
	120	struct ocfs2_stack_operations {
	121	/*
	122	* The fs code calls ocfs2_cluster_connect() to attach a new
	123	* filesystem to the cluster stack. The ->connect() op is passed
	124	* an ocfs2_cluster_connection with the name and recovery field
	125	* filled in.
	126	*
	127	* The stack must set up any notification mechanisms and create
	128	* the filesystem lockspace in the DLM. The lockspace should be
	129	* stored on cc_lockspace. Any other information can be stored on
	130	* cc_private.
	131	*
	132	* ->connect() must not return until it is guaranteed that
	133	*
25985edc	134	* - Node down notifications for the filesystem will be received
e3dad42b JB	135	* and passed to conn->cc_recovery_handler().
	136	* - Locking requests for the filesystem will be processed.
	137	*/
	138	int (connect)(struct ocfs2_cluster_connection conn);
	139
	140	/*
	141	* The fs code calls ocfs2_cluster_disconnect() when a filesystem
	142	* no longer needs cluster services. All DLM locks have been
	143	* dropped, and recovery notification is being ignored by the
	144	* fs code. The stack must disengage from the DLM and discontinue
	145	* recovery notification.
	146	*
	147	* Once ->disconnect() has returned, the connection structure will
	148	* be freed. Thus, a stack must not return from ->disconnect()
	149	* until it will no longer reference the conn pointer.
286eaa95	150	*
2c39450b JB	151	* Once this call returns, the stack glue will be dropping this
2c39450b JB	152	* connection's reference on the module.
e3dad42b	153	*/
2c39450b	154	int (disconnect)(struct ocfs2_cluster_connection conn);
e3dad42b JB	155
	156	/*
	157	* ->this_node() returns the cluster's unique identifier for the
	158	* local node.
	159	*/
3e834151 GR	160	int (this_node)(struct ocfs2_cluster_connection conn,
3e834151 GR	161	unsigned int *node);
e3dad42b JB	162
	163	/*
	164	* Call the underlying dlm lock function. The ->dlm_lock()
	165	* callback should convert the flags and mode as appropriate.
	166	*
	167	* ast and bast functions are not part of the call because the
	168	* stack will likely want to wrap ast and bast calls before passing
a796d286 JB	169	* them to stack->sp_proto. There is no astarg. The lksb will
	170	* be passed back to the ast and bast functions. The caller can
	171	* use this to find their object.
e3dad42b JB	172	*/
	173	int (dlm_lock)(struct ocfs2_cluster_connection conn,
	174	int mode,
c0e41338	175	struct ocfs2_dlm_lksb *lksb,
e3dad42b JB	176	u32 flags,
e3dad42b JB	177	void *name,
a796d286	178	unsigned int namelen);
e3dad42b JB	179
	180	/*
	181	* Call the underlying dlm unlock function. The ->dlm_unlock()
	182	* function should convert the flags as appropriate.
	183	*
	184	* The unlock ast is not passed, as the stack will want to wrap
a796d286 JB	185	* it before calling stack->sp_proto->lp_unlock_ast(). There is
	186	* no astarg. The lksb will be passed back to the unlock ast
	187	* function. The caller can use this to find their object.
e3dad42b JB	188	*/
e3dad42b JB	189	int (dlm_unlock)(struct ocfs2_cluster_connection conn,
c0e41338	190	struct ocfs2_dlm_lksb *lksb,
a796d286	191	u32 flags);
e3dad42b JB	192
	193	/*
	194	* Return the status of the current lock status block. The fs
	195	* code should never dereference the union. The ->lock_status()
	196	* callback pulls out the stack-specific lksb, converts the status
	197	* to a proper errno, and returns it.
	198	*/
c0e41338	199	int (lock_status)(struct ocfs2_dlm_lksb lksb);
e3dad42b	200
1c520dfb JB	201	/*
	202	* Return non-zero if the LVB is valid.
	203	*/
c0e41338	204	int (lvb_valid)(struct ocfs2_dlm_lksb lksb);
1c520dfb	205
e3dad42b JB	206	/*
	207	* Pull the lvb pointer off of the stack-specific lksb.
	208	*/
c0e41338	209	void (lock_lvb)(struct ocfs2_dlm_lksb *lksb);
e3dad42b	210
53da4939 MF	211	/*
	212	* Cluster-aware posix locks
	213	*
	214	* This is NULL for stacks which do not support posix locks.
	215	*/
	216	int (plock)(struct ocfs2_cluster_connection conn,
	217	u64 ino,
	218	struct file *file,
	219	int cmd,
	220	struct file_lock *fl);
	221
e3dad42b JB	222	/*
	223	* This is an optoinal debugging hook. If provided, the
	224	* stack can dump debugging information about this lock.
	225	*/
c0e41338	226	void (dump_lksb)(struct ocfs2_dlm_lksb lksb);
e3dad42b JB	227	};
e3dad42b JB	228
286eaa95 JB	229	/*
	230	* Each stack plugin must describe itself by registering a
	231	* ocfs2_stack_plugin structure. This is only seen by stackglue and the
	232	* stack driver.
	233	*/
	234	struct ocfs2_stack_plugin {
	235	char *sp_name;
	236	struct ocfs2_stack_operations *sp_ops;
	237	struct module *sp_owner;
	238
	239	/* These are managed by the stackglue code. */
	240	struct list_head sp_list;
	241	unsigned int sp_count;
e603cfb0	242	struct ocfs2_protocol_version sp_max_proto;
286eaa95 JB	243	};
	244
	245
	246	/* Used by the filesystem */
9c6c877c	247	int ocfs2_cluster_connect(const char *stack_name,
c74a3bdd GR	248	const char *cluster_name,
c74a3bdd GR	249	int cluster_name_len,
9c6c877c	250	const char *group,
4670c46d	251	int grouplen,
553b5eb9	252	struct ocfs2_locking_protocol *lproto,
4670c46d JB	253	void (*recovery_handler)(int node_num,
	254	void *recovery_data),
	255	void *recovery_data,
	256	struct ocfs2_cluster_connection **conn);
cbe0e331 JB	257	/*
	258	* Used by callers that don't store their stack name. They must ensure
	259	* all nodes have the same stack.
	260	*/
	261	int ocfs2_cluster_connect_agnostic(const char *group,
	262	int grouplen,
	263	struct ocfs2_locking_protocol *lproto,
	264	void (*recovery_handler)(int node_num,
	265	void *recovery_data),
	266	void *recovery_data,
	267	struct ocfs2_cluster_connection **conn);
286eaa95 JB	268	int ocfs2_cluster_disconnect(struct ocfs2_cluster_connection *conn,
286eaa95 JB	269	int hangup_pending);
6953b4c0	270	void ocfs2_cluster_hangup(const char *group, int grouplen);
3e834151 GR	271	int ocfs2_cluster_this_node(struct ocfs2_cluster_connection *conn,
3e834151 GR	272	unsigned int *node);
4670c46d	273
cf4d8d75	274	struct ocfs2_lock_res;
4670c46d	275	int ocfs2_dlm_lock(struct ocfs2_cluster_connection *conn,
24ef1815	276	int mode,
c0e41338	277	struct ocfs2_dlm_lksb *lksb,
24ef1815 JB	278	u32 flags,
24ef1815 JB	279	void *name,
a796d286	280	unsigned int namelen);
4670c46d	281	int ocfs2_dlm_unlock(struct ocfs2_cluster_connection *conn,
c0e41338	282	struct ocfs2_dlm_lksb *lksb,
a796d286	283	u32 flags);
24ef1815	284
c0e41338 JB	285	int ocfs2_dlm_lock_status(struct ocfs2_dlm_lksb *lksb);
	286	int ocfs2_dlm_lvb_valid(struct ocfs2_dlm_lksb *lksb);
	287	void ocfs2_dlm_lvb(struct ocfs2_dlm_lksb lksb);
	288	void ocfs2_dlm_dump_lksb(struct ocfs2_dlm_lksb *lksb);
8f2c9c1b	289
53da4939 MF	290	int ocfs2_stack_supports_plocks(void);
	291	int ocfs2_plock(struct ocfs2_cluster_connection *conn, u64 ino,
	292	struct file file, int cmd, struct file_lock fl);
	293
553b5eb9	294	void ocfs2_stack_glue_set_max_proto_version(struct ocfs2_protocol_version *max_proto);
24ef1815	295
286eaa95 JB	296
	297	/* Used by stack plugins */
	298	int ocfs2_stack_glue_register(struct ocfs2_stack_plugin *plugin);
	299	void ocfs2_stack_glue_unregister(struct ocfs2_stack_plugin *plugin);
3878f110	300
24ef1815	301	#endif /* STACKGLUE_H */