[linux.git] / fs / ocfs2 / ocfs2_lockid.h

/* -*- mode: c; c-basic-offset: 8; -*-
 * vim: noexpandtab sw=8 ts=8 sts=0:
 *
 * ocfs2_lockid.h
 *
 * Defines OCFS2 lockid bits.
 *
 * Copyright (C) 2002, 2005 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 OCFS2_LOCKID_H
#define OCFS2_LOCKID_H

/* lock ids are made up in the following manner:
 * name[0]     --> type
 * name[1-6]   --> 6 pad characters, reserved for now
 * name[7-22]  --> block number, expressed in hex as 16 chars
 * name[23-30] --> i_generation, expressed in hex 8 chars
 * name[31]    --> '\0' */
#define OCFS2_LOCK_ID_MAX_LEN  32
#define OCFS2_LOCK_ID_PAD "000000"

#define OCFS2_DENTRY_LOCK_INO_START 18

enum ocfs2_lock_type {
	OCFS2_LOCK_TYPE_META = 0,
	OCFS2_LOCK_TYPE_DATA,
	OCFS2_LOCK_TYPE_SUPER,
	OCFS2_LOCK_TYPE_RENAME,
	OCFS2_LOCK_TYPE_RW,
	OCFS2_LOCK_TYPE_DENTRY,
	OCFS2_LOCK_TYPE_OPEN,
	OCFS2_LOCK_TYPE_FLOCK,
	OCFS2_LOCK_TYPE_QINFO,
	OCFS2_LOCK_TYPE_NFS_SYNC,
	OCFS2_LOCK_TYPE_ORPHAN_SCAN,
	OCFS2_LOCK_TYPE_REFCOUNT,
	OCFS2_NUM_LOCK_TYPES
};

static inline char ocfs2_lock_type_char(enum ocfs2_lock_type type)
{
	char c;
	switch (type) {
		case OCFS2_LOCK_TYPE_META:
			c = 'M';
			break;
		case OCFS2_LOCK_TYPE_DATA:
			c = 'D';
			break;
		case OCFS2_LOCK_TYPE_SUPER:
			c = 'S';
			break;
		case OCFS2_LOCK_TYPE_RENAME:
			c = 'R';
			break;
		case OCFS2_LOCK_TYPE_RW:
			c = 'W';
			break;
		case OCFS2_LOCK_TYPE_DENTRY:
			c = 'N';
			break;
		case OCFS2_LOCK_TYPE_OPEN:
			c = 'O';
			break;
		case OCFS2_LOCK_TYPE_FLOCK:
			c = 'F';
			break;
		case OCFS2_LOCK_TYPE_QINFO:
			c = 'Q';
			break;
		case OCFS2_LOCK_TYPE_NFS_SYNC:
			c = 'Y';
			break;
		case OCFS2_LOCK_TYPE_ORPHAN_SCAN:
			c = 'P';
			break;
		case OCFS2_LOCK_TYPE_REFCOUNT:
			c = 'T';
			break;
		default:
			c = '\0';
	}

	return c;
}

static char *ocfs2_lock_type_strings[] = {
	[OCFS2_LOCK_TYPE_META] = "Meta",
	[OCFS2_LOCK_TYPE_DATA] = "Data",
	[OCFS2_LOCK_TYPE_SUPER] = "Super",
	[OCFS2_LOCK_TYPE_RENAME] = "Rename",
	/* Need to differntiate from [R]ename.. serializing writes is the
	 * important job it does, anyway. */
	[OCFS2_LOCK_TYPE_RW] = "Write/Read",
	[OCFS2_LOCK_TYPE_DENTRY] = "Dentry",
	[OCFS2_LOCK_TYPE_OPEN] = "Open",
	[OCFS2_LOCK_TYPE_FLOCK] = "Flock",
	[OCFS2_LOCK_TYPE_QINFO] = "Quota",
	[OCFS2_LOCK_TYPE_NFS_SYNC] = "NFSSync",
	[OCFS2_LOCK_TYPE_ORPHAN_SCAN] = "OrphanScan",
	[OCFS2_LOCK_TYPE_REFCOUNT] = "Refcount",
};

static inline const char *ocfs2_lock_type_string(enum ocfs2_lock_type type)
{
#ifdef __KERNEL__
	BUG_ON(type >= OCFS2_NUM_LOCK_TYPES);
#endif
	return ocfs2_lock_type_strings[type];
}

#endif  /* OCFS2_LOCKID_H */
Commit	Line	Data
ccd979bd MF	1	/* -- mode: c; c-basic-offset: 8; --
	2	* vim: noexpandtab sw=8 ts=8 sts=0:
	3	*
	4	* ocfs2_lockid.h
	5	*
	6	* Defines OCFS2 lockid bits.
	7	*
	8	* Copyright (C) 2002, 2005 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	#ifndef OCFS2_LOCKID_H
	27	#define OCFS2_LOCKID_H
	28
	29	/* lock ids are made up in the following manner:
	30	* name[0] --> type
	31	* name[1-6] --> 6 pad characters, reserved for now
	32	* name[7-22] --> block number, expressed in hex as 16 chars
	33	* name[23-30] --> i_generation, expressed in hex 8 chars
	34	* name[31] --> '\0' */
	35	#define OCFS2_LOCK_ID_MAX_LEN 32
	36	#define OCFS2_LOCK_ID_PAD "000000"
	37
d680efe9 MF	38	#define OCFS2_DENTRY_LOCK_INO_START 18
d680efe9 MF	39
ccd979bd MF	40	enum ocfs2_lock_type {
	41	OCFS2_LOCK_TYPE_META = 0,
	42	OCFS2_LOCK_TYPE_DATA,
	43	OCFS2_LOCK_TYPE_SUPER,
	44	OCFS2_LOCK_TYPE_RENAME,
	45	OCFS2_LOCK_TYPE_RW,
d680efe9	46	OCFS2_LOCK_TYPE_DENTRY,
50008630	47	OCFS2_LOCK_TYPE_OPEN,
cf8e06f1	48	OCFS2_LOCK_TYPE_FLOCK,
9e33d69f	49	OCFS2_LOCK_TYPE_QINFO,
6ca497a8	50	OCFS2_LOCK_TYPE_NFS_SYNC,
83273932	51	OCFS2_LOCK_TYPE_ORPHAN_SCAN,
8dec98ed	52	OCFS2_LOCK_TYPE_REFCOUNT,
ccd979bd MF	53	OCFS2_NUM_LOCK_TYPES
	54	};
	55
	56	static inline char ocfs2_lock_type_char(enum ocfs2_lock_type type)
	57	{
	58	char c;
	59	switch (type) {
	60	case OCFS2_LOCK_TYPE_META:
	61	c = 'M';
	62	break;
	63	case OCFS2_LOCK_TYPE_DATA:
	64	c = 'D';
	65	break;
	66	case OCFS2_LOCK_TYPE_SUPER:
	67	c = 'S';
	68	break;
	69	case OCFS2_LOCK_TYPE_RENAME:
	70	c = 'R';
	71	break;
	72	case OCFS2_LOCK_TYPE_RW:
	73	c = 'W';
	74	break;
d680efe9 MF	75	case OCFS2_LOCK_TYPE_DENTRY:
	76	c = 'N';
	77	break;
50008630 TY	78	case OCFS2_LOCK_TYPE_OPEN:
	79	c = 'O';
	80	break;
cf8e06f1 MF	81	case OCFS2_LOCK_TYPE_FLOCK:
	82	c = 'F';
	83	break;
9e33d69f JK	84	case OCFS2_LOCK_TYPE_QINFO:
	85	c = 'Q';
	86	break;
6ca497a8	87	case OCFS2_LOCK_TYPE_NFS_SYNC:
	88	c = 'Y';
	89	break;
83273932 SE	90	case OCFS2_LOCK_TYPE_ORPHAN_SCAN:
	91	c = 'P';
	92	break;
8dec98ed TM	93	case OCFS2_LOCK_TYPE_REFCOUNT:
	94	c = 'T';
	95	break;
ccd979bd MF	96	default:
	97	c = '\0';
	98	}
	99
	100	return c;
	101	}
	102
d680efe9 MF	103	static char *ocfs2_lock_type_strings[] = {
	104	[OCFS2_LOCK_TYPE_META] = "Meta",
	105	[OCFS2_LOCK_TYPE_DATA] = "Data",
	106	[OCFS2_LOCK_TYPE_SUPER] = "Super",
	107	[OCFS2_LOCK_TYPE_RENAME] = "Rename",
	108	/* Need to differntiate from [R]ename.. serializing writes is the
	109	* important job it does, anyway. */
	110	[OCFS2_LOCK_TYPE_RW] = "Write/Read",
	111	[OCFS2_LOCK_TYPE_DENTRY] = "Dentry",
50008630	112	[OCFS2_LOCK_TYPE_OPEN] = "Open",
cf8e06f1	113	[OCFS2_LOCK_TYPE_FLOCK] = "Flock",
9e33d69f	114	[OCFS2_LOCK_TYPE_QINFO] = "Quota",
a8b88d3d	115	[OCFS2_LOCK_TYPE_NFS_SYNC] = "NFSSync",
83273932	116	[OCFS2_LOCK_TYPE_ORPHAN_SCAN] = "OrphanScan",
8dec98ed	117	[OCFS2_LOCK_TYPE_REFCOUNT] = "Refcount",
d680efe9 MF	118	};
	119
	120	static inline const char *ocfs2_lock_type_string(enum ocfs2_lock_type type)
	121	{
	122	#ifdef __KERNEL__
8f318311	123	BUG_ON(type >= OCFS2_NUM_LOCK_TYPES);
d680efe9 MF	124	#endif
	125	return ocfs2_lock_type_strings[type];
	126	}
	127
ccd979bd	128	#endif /* OCFS2_LOCKID_H */